summaryrefslogtreecommitdiffstats
path: root/chrome/browser/views/info_bar_item_view.h
blob: e4fa4d297f981d46801198575e451e002ef14035 (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef CHROME_BROWSER_VIEWS_INFO_BAR_ITEM_VIEW_H__
#define CHROME_BROWSER_VIEWS_INFO_BAR_ITEM_VIEW_H__

#include "chrome/browser/views/info_bar_view.h"
#include "chrome/common/slide_animation.h"
#include "chrome/views/button.h"

namespace ChromeViews {
  class ExternalFocusTracker;
  class ImageView;
}
// Note: An InfoBarItemView must be added as a child of InfoBarView to be
// displayed correctly.
//
// InfoBarItemView is basically a view container that lays out views in a
// horizontal row, on either the left or the right, with specified padding. It
// has a close button on the far right, which can't be removed, and closes the
// info bar by default. An icon can be set to be displayed leading all other
// views by calling SetIcon().
//
// A view can be added to either the left or the right of the info bar by
// calling AddChildViewTrailing and AddChildViewLeading.
//
// The most recently added views to either side will always be located further
// towards the center than views added less recently, with the first views added
// to the left or right being located on the leftmost or rightmost sides of the
// info bar, respectively. Each view has a default spacing from the next
// view added to that side, but you can edit that by specifying a padding when
// you add a view. For example, if you add a view to the left with a padding of
// 6 specified, it will be placed in the leftmost position, and the next view
// added to the left will be 6 pixels to the right of the previously added view.
class InfoBarItemView : public ChromeViews::View,
                        public ChromeViews::BaseButton::ButtonListener,
                        public AnimationDelegate {
 public:
  InfoBarItemView();

  virtual ~InfoBarItemView();

  // The preferred height is equal to the maximum height of all views
  // in the info bar. Preferred width is equal to the parents width.
  virtual void GetPreferredSize(CSize* out);

  // Lays out all child views of the info bar from trailing to leading.
  virtual void Layout();

  virtual void DidChangeBounds(const CRect& previous, const CRect& current);

  // Starts the close animation, which will end in the bar closing itself.
  void BeginClose();

  // Removes this InfoBarItem from its parent view and then deletes it.
  void Close();

  // ButtonListener Method
  // Calls CloseButtonPressed() when the close button is pressed
  virtual void ButtonPressed(ChromeViews::BaseButton* button);

  // Adds |view| to the info bar, directly leading the last trailing view
  // added, according to that views specified padding. The next trailing view
  // added will in turn be leading this view by |leading_padding| pixels.
  // Specify 0 for |leading_padding| if the views should be flush.
  void AddChildViewTrailing(ChromeViews::View* view, int leading_padding);

  // Calls AddChildViewTrailing with a default amount of padding.
  void AddChildViewTrailing(ChromeViews::View* view);

  // Adds |view| to the info bar, directly trailing the last leading view
  // added, according to that views specified padding. The next leading view
  // added will in turn be trailing this view by |trailing_padding| pixels.
  // Specify 0 for |trailing_padding| if the views should be flush.
  void AddChildViewLeading(ChromeViews::View* view, int trailing_padding);

  // Calls AddChildViewLeading with a default amount of padding.
  void AddChildViewLeading(ChromeViews::View* view);

  // Sets the icon to be displayed leading all other views in the info bar.
  // The icon will be displayed at its images height and width by default.
  void SetIcon(const SkBitmap& icon);

 protected:
  // Returns the desired position for a centered object of size |size| within
  // a region of size |target_size|.
  static int CenterPosition(int size, int target_size);

  virtual void ViewHierarchyChanged(bool is_add, View *parent, View *child);

  // Overridden from the basic Views AddChildView. Calls
  // AddChildViewTrailing(view)
  virtual void AddChildView(ChromeViews::View* view);

  // Overridden from basic View. Adds the view to the same side as the view
  // at index. Does *not* insert at the specified index, or even neccesarily
  // close to it.
  virtual void AddChildView(int index, ChromeViews::View* view);

  // Overridden from the basic Views AddChildView, removes the specified view
  // as well as its padding.
  virtual void RemoveChildView(ChromeViews::View* view);

  // Invoked whenever the close button is pressed. Closes infobar by default.
  virtual void CloseButtonPressed();

 private:
  // Creates cancel button.
  void Init();

  // SlideAnimationDelegate implementation.
  virtual void AnimationProgressed(const Animation* animation);
  virtual void AnimationEnded(const Animation* animation);

  scoped_ptr<SlideAnimation> animation_;

  // View index where all new views will be inserted. Any view at an index less
  // than insert_index will be laid out will be leading views (left aligned in
  // left to right languages), any view greater than or equal to insert_index_
  // will be laid out trailing (right aligned in left to right languages).
  int insert_index_;

  // Dismisses the info bar by default.
  ChromeViews::Button* close_button_;

  // Optional icon to be displayed at the far left of the infobar.
  ChromeViews::ImageView* icon_;

  // Tracks and stores the last focused view which is not the InfoBarItemView or
  // any of its children. Used to restore focus once the InfoBarItemView is
  // closed.
  scoped_ptr<ChromeViews::ExternalFocusTracker> focus_tracker_;

  DISALLOW_EVIL_CONSTRUCTORS(InfoBarItemView);
};

#endif // CHROME_BROWSER_VIEWS_INFO_BAR_ITEM_VIEW_H__