ui/views/bubble/bubble_frame_view.h

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