File: label_button_image_container.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (73 lines) | stat: -rw-r--r-- 2,881 bytes parent folder | download | duplicates (9)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_VIEWS_CONTROLS_BUTTON_LABEL_BUTTON_IMAGE_CONTAINER_H_
#define UI_VIEWS_CONTROLS_BUTTON_LABEL_BUTTON_IMAGE_CONTAINER_H_

#include <memory>

#include "base/memory/raw_ptr.h"
#include "ui/views/view_tracker.h"
#include "ui/views/views_export.h"

namespace views {

class View;
class LabelButton;

// Abstract interface used by LabelButton to handle updates to the button
// image(s). This interface lets callers configure the button to have one image
// or multiple without LabelButton itself needing to understand the details.
// LabelButton can simply call CreateView() to get a view it can add as a child,
// then call UpdateImage() any time state changes in such a way that the
// image(s) might need to be updated. Concrete instances of this class are
// responsible for laying out any image(s) and updating them in response to
// calls to UpdateImage(), as well as any other relevant signals.
class VIEWS_EXPORT LabelButtonImageContainer {
 public:
  LabelButtonImageContainer() = default;
  LabelButtonImageContainer(const LabelButtonImageContainer&) = delete;
  LabelButtonImageContainer& operator=(const LabelButtonImageContainer&) =
      delete;
  virtual ~LabelButtonImageContainer() = default;

  // Returns a view holding whatever image(s) are desired. Calls to
  // UpdateImage() outside this view's lifetime will have no effect.
  virtual std::unique_ptr<View> CreateView() = 0;

  // Gets a pointer to a previously created view. Returns nullptr if no view was
  // created.
  virtual View* GetView() = 0;
  virtual const View* GetView() const = 0;

  // Called when image(s) in the created view may need updating. `button` is the
  // LabelButton which is displaying the images. Subclasses should respond to
  // this by updating any image(s) appropriately based on the button's current
  // state and any other state the container is tracking.
  virtual void UpdateImage(const LabelButton* button) = 0;
};

// The common-case implementation of LabelButtonImageContainer, which provides a
// single image that tracks the LabelButton's ButtonState.
class VIEWS_EXPORT SingleImageContainer final
    : public LabelButtonImageContainer {
 public:
  SingleImageContainer() = default;
  SingleImageContainer(const SingleImageContainer&) = delete;
  SingleImageContainer& operator=(const SingleImageContainer&) = delete;
  ~SingleImageContainer() override = default;

  // LabelButtonImageContainer
  std::unique_ptr<View> CreateView() override;
  View* GetView() override;
  const View* GetView() const override;
  void UpdateImage(const LabelButton* button) override;

 private:
  views::ViewTracker image_view_tracker_;
};

}  // namespace views

#endif  // UI_VIEWS_CONTROLS_BUTTON_LABEL_BUTTON_IMAGE_CONTAINER_H_