1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef UI_VIEWS_BUBBLE_BUBBLE_FRAME_VIEW_H_
6#define UI_VIEWS_BUBBLE_BUBBLE_FRAME_VIEW_H_
7
8#include "base/basictypes.h"
9#include "base/compiler_specific.h"
10#include "base/gtest_prod_util.h"
11#include "ui/gfx/insets.h"
12#include "ui/views/controls/button/button.h"
13#include "ui/views/window/non_client_view.h"
14
15namespace gfx {
16class FontList;
17}
18
19namespace views {
20
21class Label;
22class LabelButton;
23class BubbleBorder;
24
25// The non-client frame view of bubble-styled widgets.
26class VIEWS_EXPORT BubbleFrameView : public NonClientFrameView,
27                                     public ButtonListener {
28 public:
29  // Internal class name.
30  static const char kViewClassName[];
31
32  // Insets to make bubble contents align horizontal with the bubble title.
33  // NOTE: this does not take into account whether a title actually exists.
34  static gfx::Insets GetTitleInsets();
35
36  explicit BubbleFrameView(const gfx::Insets& content_margins);
37  virtual ~BubbleFrameView();
38
39  // NonClientFrameView overrides:
40  virtual gfx::Rect GetBoundsForClientView() const OVERRIDE;
41  virtual gfx::Rect GetWindowBoundsForClientBounds(
42      const gfx::Rect& client_bounds) const OVERRIDE;
43  virtual int NonClientHitTest(const gfx::Point& point) OVERRIDE;
44  virtual void GetWindowMask(const gfx::Size& size,
45                             gfx::Path* window_mask) OVERRIDE;
46  virtual void ResetWindowControls() OVERRIDE;
47  virtual void UpdateWindowIcon() OVERRIDE;
48  virtual void UpdateWindowTitle() OVERRIDE;
49
50  // Set the FontList to be used for the title of the bubble.
51  // Caller must arrange to update the layout to have the call take effect.
52  void SetTitleFontList(const gfx::FontList& font_list);
53
54  // View overrides:
55  virtual gfx::Insets GetInsets() const OVERRIDE;
56  virtual gfx::Size GetPreferredSize() const OVERRIDE;
57  virtual gfx::Size GetMinimumSize() const OVERRIDE;
58  virtual void Layout() OVERRIDE;
59  virtual const char* GetClassName() const OVERRIDE;
60  virtual void ChildPreferredSizeChanged(View* child) OVERRIDE;
61  virtual void OnThemeChanged() OVERRIDE;
62  virtual void OnNativeThemeChanged(const ui::NativeTheme* theme) OVERRIDE;
63
64  // Overridden from ButtonListener:
65  virtual void ButtonPressed(Button* sender, const ui::Event& event) OVERRIDE;
66
67  // Use bubble_border() and SetBubbleBorder(), not border() and SetBorder().
68  BubbleBorder* bubble_border() const { return bubble_border_; }
69  void SetBubbleBorder(scoped_ptr<BubbleBorder> border);
70
71  gfx::Insets content_margins() const { return content_margins_; }
72
73  void SetTitlebarExtraView(View* view);
74
75  // Given the size of the contents and the rect to point at, returns the bounds
76  // of the bubble window. The bubble's arrow location may change if the bubble
77  // does not fit on the monitor and |adjust_if_offscreen| is true.
78  gfx::Rect GetUpdatedWindowBounds(const gfx::Rect& anchor_rect,
79                                   gfx::Size client_size,
80                                   bool adjust_if_offscreen);
81
82 protected:
83  // Returns the available screen bounds if the frame were to show in |rect|.
84  virtual gfx::Rect GetAvailableScreenBounds(const gfx::Rect& rect);
85
86 private:
87  FRIEND_TEST_ALL_PREFIXES(BubbleFrameViewTest, GetBoundsForClientView);
88
89  // Mirrors the bubble's arrow location on the |vertical| or horizontal axis,
90  // if the generated window bounds don't fit in the monitor bounds.
91  void MirrorArrowIfOffScreen(bool vertical,
92                              const gfx::Rect& anchor_rect,
93                              const gfx::Size& client_size);
94
95  // Adjust the bubble's arrow offsets if the generated window bounds don't fit
96  // in the monitor bounds.
97  void OffsetArrowIfOffScreen(const gfx::Rect& anchor_rect,
98                              const gfx::Size& client_size);
99
100  // Calculates the size needed to accommodate the given client area.
101  gfx::Size GetSizeForClientSize(const gfx::Size& client_size) const;
102
103  // The bubble border.
104  BubbleBorder* bubble_border_;
105
106  // Margins between the content and the inside of the border, in pixels.
107  gfx::Insets content_margins_;
108
109  // The optional title and (x) close button.
110  Label* title_;
111  LabelButton* close_;
112
113  // When supplied, this view is placed in the titlebar between the title and
114  // (x) close button.
115  View* titlebar_extra_view_;
116
117  DISALLOW_COPY_AND_ASSIGN(BubbleFrameView);
118};
119
120}  // namespace views
121
122#endif  // UI_VIEWS_BUBBLE_BUBBLE_FRAME_VIEW_H_
123