summaryrefslogtreecommitdiffstats
path: root/chrome/views/native_button.h
blob: 9a4243950c0171d1840ec740507bd3e0ecc1af31 (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
// Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_VIEWS_NATIVE_BUTTON_H__
#define CHROME_VIEWS_NATIVE_BUTTON_H__

#include <string>

#include "base/gfx/size.h"
#include "chrome/common/gfx/chrome_font.h"
#include "chrome/views/native_control.h"

namespace ChromeViews {


class HWNDView;

////////////////////////////////////////////////////////////////////////////////
//
// NativeButton is a wrapper for a windows native button
// TODO(beng): (Cleanup) this should derive also from some button-like base to
//             get all the listenery-stuff for free and to work with
//             AddManagedButton.
//
////////////////////////////////////////////////////////////////////////////////
class NativeButton : public NativeControl {
 public:
  explicit NativeButton(const std::wstring& label);
  NativeButton(const std::wstring& label, bool is_default);
  virtual ~NativeButton();

  virtual void GetPreferredSize(CSize *out);

  void SetLabel(const std::wstring& l);
  const std::wstring GetLabel() const;

  class Listener {
   public:
    //
    // This is invoked once the button is released.
    virtual void ButtonPressed(NativeButton* sender) = 0;
  };

  //
  // The the listener, the object that receives a notification when this
  // button is pressed.
  void SetListener(Listener* listener);

  // Set the font used by this button.
  void SetFont(const ChromeFont& font) { font_ = font; }

  // Adds some internal padding to the button.  The |size| specified is applied
  // on both sides of the button for each directions
  void SetPadding(CSize size);

  virtual LRESULT OnNotify(int w_param, LPNMHDR l_param);
  virtual LRESULT OnCommand(UINT code, int id, HWND source);

  // Invoked when the accelerator associated with the button is pressed.
  virtual bool AcceleratorPressed(const Accelerator& accelerator);

  // Sets the minimum size of the button from the specified size (in dialog
  // units). If the width/height is non-zero, the preferred size of the button
  // is max(preferred size of the content + padding, dlus converted to pixels).
  //
  // The default is 50, 14.
  void SetMinSizeFromDLUs(const gfx::Size& dlu_size) {
    min_dlu_size_ = dlu_size;
  }

  // Returns the MSAA role of the current view. The role is what assistive
  // technologies (ATs) use to determine what behavior to expect from a given
  // control.
  bool GetAccessibleRole(VARIANT* role);

  // Returns a brief, identifying string, containing a unique, readable name.
  bool GetAccessibleName(std::wstring* name);

  // Assigns an accessible string name.
  void SetAccessibleName(const std::wstring& name);

 protected:

  virtual HWND CreateNativeControl(HWND parent_container);

  // Sub-classes can call this method to cause the native button to reflect
  // the current state
  virtual void UpdateNativeButton();

  // Sub-classes must override this method to properly configure the native
  // button given the current state
  virtual void ConfigureNativeButton(HWND hwnd);

  // Overridden from NativeControl so we can activate the button when Enter is
  // pressed.
  virtual bool NotifyOnKeyDown() const;
  virtual bool OnKeyDown(int virtual_key_code);

 private:
  NativeButton() {}

  // Initializes the button. If |is_default| is true, this appears like the
  // "default" button, and will register Enter as its keyboard accelerator.
  void Init(const std::wstring& label, bool is_default);

  void Clicked();

  std::wstring label_;
  ChromeFont font_;
  Listener* listener_;

  CSize padding_;

  // True if the button should be rendered to appear like the "default" button
  // in the containing dialog box. Default buttons register Enter as their
  // accelerator.
  bool is_default_;

  // Minimum size, in dlus (see SetMinSizeFromDLUs).
  gfx::Size min_dlu_size_;

  // Storage of strings needed for accessibility.
  std::wstring accessible_name_;

  DISALLOW_EVIL_CONSTRUCTORS(NativeButton);
};

}

#endif  // CHROME_VIEWS_NATIVE_BUTTON_H__