Improve YouCompleteMe handling of Blink header without source files.
[chromium-blink-merge.git] / ui / views / view.h
blobb0340ea14fbe07ba0c59ffdc57de8f6ea4b0bbec
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.
5 #ifndef UI_VIEWS_VIEW_H_
6 #define UI_VIEWS_VIEW_H_
8 #include <algorithm>
9 #include <map>
10 #include <set>
11 #include <string>
12 #include <vector>
14 #include "base/compiler_specific.h"
15 #include "base/i18n/rtl.h"
16 #include "base/logging.h"
17 #include "base/memory/scoped_ptr.h"
18 #include "build/build_config.h"
19 #include "ui/accessibility/ax_enums.h"
20 #include "ui/base/accelerators/accelerator.h"
21 #include "ui/base/dragdrop/drag_drop_types.h"
22 #include "ui/base/dragdrop/drop_target_event.h"
23 #include "ui/base/dragdrop/os_exchange_data.h"
24 #include "ui/base/ui_base_types.h"
25 #include "ui/compositor/layer_delegate.h"
26 #include "ui/compositor/layer_owner.h"
27 #include "ui/events/event.h"
28 #include "ui/events/event_target.h"
29 #include "ui/gfx/geometry/r_tree.h"
30 #include "ui/gfx/insets.h"
31 #include "ui/gfx/native_widget_types.h"
32 #include "ui/gfx/rect.h"
33 #include "ui/gfx/vector2d.h"
34 #include "ui/views/cull_set.h"
35 #include "ui/views/view_targeter.h"
36 #include "ui/views/views_export.h"
38 #if defined(OS_WIN)
39 #include "base/win/scoped_comptr.h"
40 #endif
42 using ui::OSExchangeData;
44 namespace gfx {
45 class Canvas;
46 class Insets;
47 class Path;
48 class Transform;
51 namespace ui {
52 struct AXViewState;
53 class Compositor;
54 class Layer;
55 class NativeTheme;
56 class TextInputClient;
57 class Texture;
58 class ThemeProvider;
61 namespace views {
63 class Background;
64 class Border;
65 class ContextMenuController;
66 class DragController;
67 class FocusManager;
68 class FocusTraversable;
69 class InputMethod;
70 class LayoutManager;
71 class NativeViewAccessibility;
72 class ScrollView;
73 class Widget;
75 namespace internal {
76 class PreEventDispatchHandler;
77 class PostEventDispatchHandler;
78 class RootView;
81 /////////////////////////////////////////////////////////////////////////////
83 // View class
85 // A View is a rectangle within the views View hierarchy. It is the base
86 // class for all Views.
88 // A View is a container of other Views (there is no such thing as a Leaf
89 // View - makes code simpler, reduces type conversion headaches, design
90 // mistakes etc)
92 // The View contains basic properties for sizing (bounds), layout (flex,
93 // orientation, etc), painting of children and event dispatch.
95 // The View also uses a simple Box Layout Manager similar to XUL's
96 // SprocketLayout system. Alternative Layout Managers implementing the
97 // LayoutManager interface can be used to lay out children if required.
99 // It is up to the subclass to implement Painting and storage of subclass -
100 // specific properties and functionality.
102 // Unless otherwise documented, views is not thread safe and should only be
103 // accessed from the main thread.
105 /////////////////////////////////////////////////////////////////////////////
106 class VIEWS_EXPORT View : public ui::LayerDelegate,
107 public ui::LayerOwner,
108 public ui::AcceleratorTarget,
109 public ui::EventTarget {
110 public:
111 typedef std::vector<View*> Views;
113 // TODO(tdanderson): Becomes obsolete with the refactoring of the event
114 // targeting logic for views and windows. See
115 // crbug.com/355425.
116 // Specifies the source of the region used in a hit test.
117 // HIT_TEST_SOURCE_MOUSE indicates the hit test is being performed with a
118 // single point and HIT_TEST_SOURCE_TOUCH indicates the hit test is being
119 // performed with a rect larger than a single point. This value can be used,
120 // for example, to add extra padding or change the shape of the hit test mask.
121 enum HitTestSource {
122 HIT_TEST_SOURCE_MOUSE,
123 HIT_TEST_SOURCE_TOUCH
126 struct ViewHierarchyChangedDetails {
127 ViewHierarchyChangedDetails()
128 : is_add(false),
129 parent(NULL),
130 child(NULL),
131 move_view(NULL) {}
133 ViewHierarchyChangedDetails(bool is_add,
134 View* parent,
135 View* child,
136 View* move_view)
137 : is_add(is_add),
138 parent(parent),
139 child(child),
140 move_view(move_view) {}
142 bool is_add;
143 // New parent if |is_add| is true, old parent if |is_add| is false.
144 View* parent;
145 // The view being added or removed.
146 View* child;
147 // If this is a move (reparent), meaning AddChildViewAt() is invoked with an
148 // existing parent, then a notification for the remove is sent first,
149 // followed by one for the add. This case can be distinguished by a
150 // non-NULL |move_view|.
151 // For the remove part of move, |move_view| is the new parent of the View
152 // being removed.
153 // For the add part of move, |move_view| is the old parent of the View being
154 // added.
155 View* move_view;
158 // Creation and lifetime -----------------------------------------------------
160 View();
161 virtual ~View();
163 // By default a View is owned by its parent unless specified otherwise here.
164 void set_owned_by_client() { owned_by_client_ = true; }
166 // Tree operations -----------------------------------------------------------
168 // Get the Widget that hosts this View, if any.
169 virtual const Widget* GetWidget() const;
170 virtual Widget* GetWidget();
172 // Adds |view| as a child of this view, optionally at |index|.
173 void AddChildView(View* view);
174 void AddChildViewAt(View* view, int index);
176 // Moves |view| to the specified |index|. A negative value for |index| moves
177 // the view at the end.
178 void ReorderChildView(View* view, int index);
180 // Removes |view| from this view. The view's parent will change to NULL.
181 void RemoveChildView(View* view);
183 // Removes all the children from this view. If |delete_children| is true,
184 // the views are deleted, unless marked as not parent owned.
185 void RemoveAllChildViews(bool delete_children);
187 int child_count() const { return static_cast<int>(children_.size()); }
188 bool has_children() const { return !children_.empty(); }
190 // Returns the child view at |index|.
191 const View* child_at(int index) const {
192 DCHECK_GE(index, 0);
193 DCHECK_LT(index, child_count());
194 return children_[index];
196 View* child_at(int index) {
197 return const_cast<View*>(const_cast<const View*>(this)->child_at(index));
200 // Returns the parent view.
201 const View* parent() const { return parent_; }
202 View* parent() { return parent_; }
204 // Returns true if |view| is contained within this View's hierarchy, even as
205 // an indirect descendant. Will return true if child is also this view.
206 bool Contains(const View* view) const;
208 // Returns the index of |view|, or -1 if |view| is not a child of this view.
209 int GetIndexOf(const View* view) const;
211 // Size and disposition ------------------------------------------------------
212 // Methods for obtaining and modifying the position and size of the view.
213 // Position is in the coordinate system of the view's parent.
214 // Position is NOT flipped for RTL. See "RTL positioning" for RTL-sensitive
215 // position accessors.
216 // Transformations are not applied on the size/position. For example, if
217 // bounds is (0, 0, 100, 100) and it is scaled by 0.5 along the X axis, the
218 // width will still be 100 (although when painted, it will be 50x50, painted
219 // at location (0, 0)).
221 void SetBounds(int x, int y, int width, int height);
222 void SetBoundsRect(const gfx::Rect& bounds);
223 void SetSize(const gfx::Size& size);
224 void SetPosition(const gfx::Point& position);
225 void SetX(int x);
226 void SetY(int y);
228 // No transformation is applied on the size or the locations.
229 const gfx::Rect& bounds() const { return bounds_; }
230 int x() const { return bounds_.x(); }
231 int y() const { return bounds_.y(); }
232 int width() const { return bounds_.width(); }
233 int height() const { return bounds_.height(); }
234 const gfx::Size& size() const { return bounds_.size(); }
236 // Returns the bounds of the content area of the view, i.e. the rectangle
237 // enclosed by the view's border.
238 gfx::Rect GetContentsBounds() const;
240 // Returns the bounds of the view in its own coordinates (i.e. position is
241 // 0, 0).
242 gfx::Rect GetLocalBounds() const;
244 // Returns the bounds of the layer in its own pixel coordinates.
245 gfx::Rect GetLayerBoundsInPixel() const;
247 // Returns the insets of the current border. If there is no border an empty
248 // insets is returned.
249 virtual gfx::Insets GetInsets() const;
251 // Returns the visible bounds of the receiver in the receivers coordinate
252 // system.
254 // When traversing the View hierarchy in order to compute the bounds, the
255 // function takes into account the mirroring setting and transformation for
256 // each View and therefore it will return the mirrored and transformed version
257 // of the visible bounds if need be.
258 gfx::Rect GetVisibleBounds() const;
260 // Return the bounds of the View in screen coordinate system.
261 gfx::Rect GetBoundsInScreen() const;
263 // Returns the baseline of this view, or -1 if this view has no baseline. The
264 // return value is relative to the preferred height.
265 virtual int GetBaseline() const;
267 // Get the size the View would like to be, if enough space were available.
268 virtual gfx::Size GetPreferredSize() const;
270 // Convenience method that sizes this view to its preferred size.
271 void SizeToPreferredSize();
273 // Gets the minimum size of the view. View's implementation invokes
274 // GetPreferredSize.
275 virtual gfx::Size GetMinimumSize() const;
277 // Gets the maximum size of the view. Currently only used for sizing shell
278 // windows.
279 virtual gfx::Size GetMaximumSize() const;
281 // Return the height necessary to display this view with the provided width.
282 // View's implementation returns the value from getPreferredSize.cy.
283 // Override if your View's preferred height depends upon the width (such
284 // as with Labels).
285 virtual int GetHeightForWidth(int w) const;
287 // Set whether this view is visible. Painting is scheduled as needed.
288 virtual void SetVisible(bool visible);
290 // Return whether a view is visible
291 bool visible() const { return visible_; }
293 // Returns true if this view is drawn on screen.
294 virtual bool IsDrawn() const;
296 // Set whether this view is enabled. A disabled view does not receive keyboard
297 // or mouse inputs. If |enabled| differs from the current value, SchedulePaint
298 // is invoked.
299 void SetEnabled(bool enabled);
301 // Returns whether the view is enabled.
302 bool enabled() const { return enabled_; }
304 // This indicates that the view completely fills its bounds in an opaque
305 // color. This doesn't affect compositing but is a hint to the compositor to
306 // optimize painting.
307 // Note that this method does not implicitly create a layer if one does not
308 // already exist for the View, but is a no-op in that case.
309 void SetFillsBoundsOpaquely(bool fills_bounds_opaquely);
311 // Transformations -----------------------------------------------------------
313 // Methods for setting transformations for a view (e.g. rotation, scaling).
315 gfx::Transform GetTransform() const;
317 // Clipping parameters. Clipping is done relative to the view bounds.
318 void set_clip_insets(gfx::Insets clip_insets) { clip_insets_ = clip_insets; }
320 // Sets the transform to the supplied transform.
321 void SetTransform(const gfx::Transform& transform);
323 // Sets whether this view paints to a layer. A view paints to a layer if
324 // either of the following are true:
325 // . the view has a non-identity transform.
326 // . SetPaintToLayer(true) has been invoked.
327 // View creates the Layer only when it exists in a Widget with a non-NULL
328 // Compositor.
329 void SetPaintToLayer(bool paint_to_layer);
331 // RTL positioning -----------------------------------------------------------
333 // Methods for accessing the bounds and position of the view, relative to its
334 // parent. The position returned is mirrored if the parent view is using a RTL
335 // layout.
337 // NOTE: in the vast majority of the cases, the mirroring implementation is
338 // transparent to the View subclasses and therefore you should use the
339 // bounds() accessor instead.
340 gfx::Rect GetMirroredBounds() const;
341 gfx::Point GetMirroredPosition() const;
342 int GetMirroredX() const;
344 // Given a rectangle specified in this View's coordinate system, the function
345 // computes the 'left' value for the mirrored rectangle within this View. If
346 // the View's UI layout is not right-to-left, then bounds.x() is returned.
348 // UI mirroring is transparent to most View subclasses and therefore there is
349 // no need to call this routine from anywhere within your subclass
350 // implementation.
351 int GetMirroredXForRect(const gfx::Rect& rect) const;
353 // Given the X coordinate of a point inside the View, this function returns
354 // the mirrored X coordinate of the point if the View's UI layout is
355 // right-to-left. If the layout is left-to-right, the same X coordinate is
356 // returned.
358 // Following are a few examples of the values returned by this function for
359 // a View with the bounds {0, 0, 100, 100} and a right-to-left layout:
361 // GetMirroredXCoordinateInView(0) -> 100
362 // GetMirroredXCoordinateInView(20) -> 80
363 // GetMirroredXCoordinateInView(99) -> 1
364 int GetMirroredXInView(int x) const;
366 // Given a X coordinate and a width inside the View, this function returns
367 // the mirrored X coordinate if the View's UI layout is right-to-left. If the
368 // layout is left-to-right, the same X coordinate is returned.
370 // Following are a few examples of the values returned by this function for
371 // a View with the bounds {0, 0, 100, 100} and a right-to-left layout:
373 // GetMirroredXCoordinateInView(0, 10) -> 90
374 // GetMirroredXCoordinateInView(20, 20) -> 60
375 int GetMirroredXWithWidthInView(int x, int w) const;
377 // Layout --------------------------------------------------------------------
379 // Lay out the child Views (set their bounds based on sizing heuristics
380 // specific to the current Layout Manager)
381 virtual void Layout();
383 // TODO(beng): I think we should remove this.
384 // Mark this view and all parents to require a relayout. This ensures the
385 // next call to Layout() will propagate to this view, even if the bounds of
386 // parent views do not change.
387 void InvalidateLayout();
389 // Gets/Sets the Layout Manager used by this view to size and place its
390 // children.
391 // The LayoutManager is owned by the View and is deleted when the view is
392 // deleted, or when a new LayoutManager is installed.
393 LayoutManager* GetLayoutManager() const;
394 void SetLayoutManager(LayoutManager* layout);
396 // Attributes ----------------------------------------------------------------
398 // The view class name.
399 static const char kViewClassName[];
401 // Return the receiving view's class name. A view class is a string which
402 // uniquely identifies the view class. It is intended to be used as a way to
403 // find out during run time if a view can be safely casted to a specific view
404 // subclass. The default implementation returns kViewClassName.
405 virtual const char* GetClassName() const;
407 // Returns the first ancestor, starting at this, whose class name is |name|.
408 // Returns null if no ancestor has the class name |name|.
409 const View* GetAncestorWithClassName(const std::string& name) const;
410 View* GetAncestorWithClassName(const std::string& name);
412 // Recursively descends the view tree starting at this view, and returns
413 // the first child that it encounters that has the given ID.
414 // Returns NULL if no matching child view is found.
415 virtual const View* GetViewByID(int id) const;
416 virtual View* GetViewByID(int id);
418 // Gets and sets the ID for this view. ID should be unique within the subtree
419 // that you intend to search for it. 0 is the default ID for views.
420 int id() const { return id_; }
421 void set_id(int id) { id_ = id; }
423 // A group id is used to tag views which are part of the same logical group.
424 // Focus can be moved between views with the same group using the arrow keys.
425 // Groups are currently used to implement radio button mutual exclusion.
426 // The group id is immutable once it's set.
427 void SetGroup(int gid);
428 // Returns the group id of the view, or -1 if the id is not set yet.
429 int GetGroup() const;
431 // If this returns true, the views from the same group can each be focused
432 // when moving focus with the Tab/Shift-Tab key. If this returns false,
433 // only the selected view from the group (obtained with
434 // GetSelectedViewForGroup()) is focused.
435 virtual bool IsGroupFocusTraversable() const;
437 // Fills |views| with all the available views which belong to the provided
438 // |group|.
439 void GetViewsInGroup(int group, Views* views);
441 // Returns the View that is currently selected in |group|.
442 // The default implementation simply returns the first View found for that
443 // group.
444 virtual View* GetSelectedViewForGroup(int group);
446 // Coordinate conversion -----------------------------------------------------
448 // Note that the utility coordinate conversions functions always operate on
449 // the mirrored position of the child Views if the parent View uses a
450 // right-to-left UI layout.
452 // Convert a point from the coordinate system of one View to another.
454 // |source| and |target| must be in the same widget, but doesn't need to be in
455 // the same view hierarchy.
456 // Neither |source| nor |target| can be NULL.
457 static void ConvertPointToTarget(const View* source,
458 const View* target,
459 gfx::Point* point);
461 // Convert |rect| from the coordinate system of |source| to the coordinate
462 // system of |target|.
464 // |source| and |target| must be in the same widget, but doesn't need to be in
465 // the same view hierarchy.
466 // Neither |source| nor |target| can be NULL.
467 static void ConvertRectToTarget(const View* source,
468 const View* target,
469 gfx::RectF* rect);
471 // Convert a point from a View's coordinate system to that of its Widget.
472 static void ConvertPointToWidget(const View* src, gfx::Point* point);
474 // Convert a point from the coordinate system of a View's Widget to that
475 // View's coordinate system.
476 static void ConvertPointFromWidget(const View* dest, gfx::Point* p);
478 // Convert a point from a View's coordinate system to that of the screen.
479 static void ConvertPointToScreen(const View* src, gfx::Point* point);
481 // Convert a point from a View's coordinate system to that of the screen.
482 static void ConvertPointFromScreen(const View* dst, gfx::Point* point);
484 // Applies transformation on the rectangle, which is in the view's coordinate
485 // system, to convert it into the parent's coordinate system.
486 gfx::Rect ConvertRectToParent(const gfx::Rect& rect) const;
488 // Converts a rectangle from this views coordinate system to its widget
489 // coordinate system.
490 gfx::Rect ConvertRectToWidget(const gfx::Rect& rect) const;
492 // Painting ------------------------------------------------------------------
494 // Mark all or part of the View's bounds as dirty (needing repaint).
495 // |r| is in the View's coordinates.
496 // Rectangle |r| should be in the view's coordinate system. The
497 // transformations are applied to it to convert it into the parent coordinate
498 // system before propagating SchedulePaint up the view hierarchy.
499 // TODO(beng): Make protected.
500 virtual void SchedulePaint();
501 virtual void SchedulePaintInRect(const gfx::Rect& r);
503 // Called by the framework to paint a View. Performs translation and clipping
504 // for View coordinates and language direction as required, allows the View
505 // to paint itself via the various OnPaint*() event handlers and then paints
506 // the hierarchy beneath it.
507 virtual void Paint(gfx::Canvas* canvas, const CullSet& cull_set);
509 // The background object is owned by this object and may be NULL.
510 void set_background(Background* b);
511 const Background* background() const { return background_.get(); }
512 Background* background() { return background_.get(); }
514 // The border object is owned by this object and may be NULL.
515 virtual void SetBorder(scoped_ptr<Border> b);
516 const Border* border() const { return border_.get(); }
517 Border* border() { return border_.get(); }
519 // Get the theme provider from the parent widget.
520 ui::ThemeProvider* GetThemeProvider() const;
522 // Returns the NativeTheme to use for this View. This calls through to
523 // GetNativeTheme() on the Widget this View is in. If this View is not in a
524 // Widget this returns ui::NativeTheme::instance().
525 ui::NativeTheme* GetNativeTheme() {
526 return const_cast<ui::NativeTheme*>(
527 const_cast<const View*>(this)->GetNativeTheme());
529 const ui::NativeTheme* GetNativeTheme() const;
531 // RTL painting --------------------------------------------------------------
533 // This method determines whether the gfx::Canvas object passed to
534 // View::Paint() needs to be transformed such that anything drawn on the
535 // canvas object during View::Paint() is flipped horizontally.
537 // By default, this function returns false (which is the initial value of
538 // |flip_canvas_on_paint_for_rtl_ui_|). View subclasses that need to paint on
539 // a flipped gfx::Canvas when the UI layout is right-to-left need to call
540 // EnableCanvasFlippingForRTLUI().
541 bool FlipCanvasOnPaintForRTLUI() const {
542 return flip_canvas_on_paint_for_rtl_ui_ ? base::i18n::IsRTL() : false;
545 // Enables or disables flipping of the gfx::Canvas during View::Paint().
546 // Note that if canvas flipping is enabled, the canvas will be flipped only
547 // if the UI layout is right-to-left; that is, the canvas will be flipped
548 // only if base::i18n::IsRTL() returns true.
550 // Enabling canvas flipping is useful for leaf views that draw an image that
551 // needs to be flipped horizontally when the UI layout is right-to-left
552 // (views::Button, for example). This method is helpful for such classes
553 // because their drawing logic stays the same and they can become agnostic to
554 // the UI directionality.
555 void EnableCanvasFlippingForRTLUI(bool enable) {
556 flip_canvas_on_paint_for_rtl_ui_ = enable;
559 // Input ---------------------------------------------------------------------
560 // The points, rects, mouse locations, and touch locations in the following
561 // functions are in the view's coordinates, except for a RootView.
563 // TODO(tdanderson): GetEventHandlerForPoint() and GetEventHandlerForRect()
564 // will be removed once their logic is moved into
565 // ViewTargeter and its derived classes. See
566 // crbug.com/355425.
568 // Convenience functions which calls into GetEventHandler() with
569 // a 1x1 rect centered at |point|.
570 View* GetEventHandlerForPoint(const gfx::Point& point);
572 // If point-based targeting should be used, return the deepest visible
573 // descendant that contains the center point of |rect|.
574 // If rect-based targeting (i.e., fuzzing) should be used, return the
575 // closest visible descendant having at least kRectTargetOverlap of
576 // its area covered by |rect|. If no such descendant exists, return the
577 // deepest visible descendant that contains the center point of |rect|.
578 // See http://goo.gl/3Jp2BD for more information about rect-based targeting.
579 virtual View* GetEventHandlerForRect(const gfx::Rect& rect);
581 // Returns the deepest visible descendant that contains the specified point
582 // and supports tooltips. If the view does not contain the point, returns
583 // NULL.
584 virtual View* GetTooltipHandlerForPoint(const gfx::Point& point);
586 // Return the cursor that should be used for this view or the default cursor.
587 // The event location is in the receiver's coordinate system. The caller is
588 // responsible for managing the lifetime of the returned object, though that
589 // lifetime may vary from platform to platform. On Windows and Aura,
590 // the cursor is a shared resource.
591 virtual gfx::NativeCursor GetCursor(const ui::MouseEvent& event);
593 // TODO(tdanderson): HitTestPoint() and HitTestRect() will be removed once
594 // their logic is moved into ViewTargeter and its
595 // derived classes. See crbug.com/355425.
597 // A convenience function which calls HitTestRect() with a rect of size
598 // 1x1 and an origin of |point|.
599 bool HitTestPoint(const gfx::Point& point) const;
601 // Tests whether |rect| intersects this view's bounds.
602 virtual bool HitTestRect(const gfx::Rect& rect) const;
604 // Returns true if this view or any of its descendants are permitted to
605 // be the target of an event.
606 virtual bool CanProcessEventsWithinSubtree() const;
608 // Returns true if the mouse cursor is over |view| and mouse events are
609 // enabled.
610 bool IsMouseHovered();
612 // This method is invoked when the user clicks on this view.
613 // The provided event is in the receiver's coordinate system.
615 // Return true if you processed the event and want to receive subsequent
616 // MouseDraggged and MouseReleased events. This also stops the event from
617 // bubbling. If you return false, the event will bubble through parent
618 // views.
620 // If you remove yourself from the tree while processing this, event bubbling
621 // stops as if you returned true, but you will not receive future events.
622 // The return value is ignored in this case.
624 // Default implementation returns true if a ContextMenuController has been
625 // set, false otherwise. Override as needed.
627 virtual bool OnMousePressed(const ui::MouseEvent& event);
629 // This method is invoked when the user clicked on this control.
630 // and is still moving the mouse with a button pressed.
631 // The provided event is in the receiver's coordinate system.
633 // Return true if you processed the event and want to receive
634 // subsequent MouseDragged and MouseReleased events.
636 // Default implementation returns true if a ContextMenuController has been
637 // set, false otherwise. Override as needed.
639 virtual bool OnMouseDragged(const ui::MouseEvent& event);
641 // This method is invoked when the user releases the mouse
642 // button. The event is in the receiver's coordinate system.
644 // Default implementation notifies the ContextMenuController is appropriate.
645 // Subclasses that wish to honor the ContextMenuController should invoke
646 // super.
647 virtual void OnMouseReleased(const ui::MouseEvent& event);
649 // This method is invoked when the mouse press/drag was canceled by a
650 // system/user gesture.
651 virtual void OnMouseCaptureLost();
653 // This method is invoked when the mouse is above this control
654 // The event is in the receiver's coordinate system.
656 // Default implementation does nothing. Override as needed.
657 virtual void OnMouseMoved(const ui::MouseEvent& event);
659 // This method is invoked when the mouse enters this control.
661 // Default implementation does nothing. Override as needed.
662 virtual void OnMouseEntered(const ui::MouseEvent& event);
664 // This method is invoked when the mouse exits this control
665 // The provided event location is always (0, 0)
666 // Default implementation does nothing. Override as needed.
667 virtual void OnMouseExited(const ui::MouseEvent& event);
669 // Set the MouseHandler for a drag session.
671 // A drag session is a stream of mouse events starting
672 // with a MousePressed event, followed by several MouseDragged
673 // events and finishing with a MouseReleased event.
675 // This method should be only invoked while processing a
676 // MouseDragged or MousePressed event.
678 // All further mouse dragged and mouse up events will be sent
679 // the MouseHandler, even if it is reparented to another window.
681 // The MouseHandler is automatically cleared when the control
682 // comes back from processing the MouseReleased event.
684 // Note: if the mouse handler is no longer connected to a
685 // view hierarchy, events won't be sent.
687 // TODO(sky): rename this.
688 virtual void SetMouseHandler(View* new_mouse_handler);
690 // Invoked when a key is pressed or released.
691 // Subclasser should return true if the event has been processed and false
692 // otherwise. If the event has not been processed, the parent will be given a
693 // chance.
694 virtual bool OnKeyPressed(const ui::KeyEvent& event);
695 virtual bool OnKeyReleased(const ui::KeyEvent& event);
697 // Invoked when the user uses the mousewheel. Implementors should return true
698 // if the event has been processed and false otherwise. This message is sent
699 // if the view is focused. If the event has not been processed, the parent
700 // will be given a chance.
701 virtual bool OnMouseWheel(const ui::MouseWheelEvent& event);
704 // See field for description.
705 void set_notify_enter_exit_on_child(bool notify) {
706 notify_enter_exit_on_child_ = notify;
708 bool notify_enter_exit_on_child() const {
709 return notify_enter_exit_on_child_;
712 // Returns the View's TextInputClient instance or NULL if the View doesn't
713 // support text input.
714 virtual ui::TextInputClient* GetTextInputClient();
716 // Convenience method to retrieve the InputMethod associated with the
717 // Widget that contains this view. Returns NULL if this view is not part of a
718 // view hierarchy with a Widget.
719 virtual InputMethod* GetInputMethod();
720 virtual const InputMethod* GetInputMethod() const;
722 // Sets a new ViewTargeter for the view, and returns the previous
723 // ViewTargeter.
724 scoped_ptr<ViewTargeter> SetEventTargeter(scoped_ptr<ViewTargeter> targeter);
726 // Overridden from ui::EventTarget:
727 virtual bool CanAcceptEvent(const ui::Event& event) OVERRIDE;
728 virtual ui::EventTarget* GetParentTarget() OVERRIDE;
729 virtual scoped_ptr<ui::EventTargetIterator> GetChildIterator() const OVERRIDE;
730 virtual ui::EventTargeter* GetEventTargeter() OVERRIDE;
731 virtual void ConvertEventToTarget(ui::EventTarget* target,
732 ui::LocatedEvent* event) OVERRIDE;
734 ViewTargeter* targeter() const { return targeter_.get(); }
736 // Overridden from ui::EventHandler:
737 virtual void OnKeyEvent(ui::KeyEvent* event) OVERRIDE;
738 virtual void OnMouseEvent(ui::MouseEvent* event) OVERRIDE;
739 virtual void OnScrollEvent(ui::ScrollEvent* event) OVERRIDE;
740 virtual void OnTouchEvent(ui::TouchEvent* event) OVERRIDE FINAL;
741 virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
743 // Accelerators --------------------------------------------------------------
745 // Sets a keyboard accelerator for that view. When the user presses the
746 // accelerator key combination, the AcceleratorPressed method is invoked.
747 // Note that you can set multiple accelerators for a view by invoking this
748 // method several times. Note also that AcceleratorPressed is invoked only
749 // when CanHandleAccelerators() is true.
750 virtual void AddAccelerator(const ui::Accelerator& accelerator);
752 // Removes the specified accelerator for this view.
753 virtual void RemoveAccelerator(const ui::Accelerator& accelerator);
755 // Removes all the keyboard accelerators for this view.
756 virtual void ResetAccelerators();
758 // Overridden from AcceleratorTarget:
759 virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE;
761 // Returns whether accelerators are enabled for this view. Accelerators are
762 // enabled if the containing widget is visible and the view is enabled() and
763 // IsDrawn()
764 virtual bool CanHandleAccelerators() const OVERRIDE;
766 // Focus ---------------------------------------------------------------------
768 // Returns whether this view currently has the focus.
769 virtual bool HasFocus() const;
771 // Returns the view that should be selected next when pressing Tab.
772 View* GetNextFocusableView();
773 const View* GetNextFocusableView() const;
775 // Returns the view that should be selected next when pressing Shift-Tab.
776 View* GetPreviousFocusableView();
778 // Sets the component that should be selected next when pressing Tab, and
779 // makes the current view the precedent view of the specified one.
780 // Note that by default views are linked in the order they have been added to
781 // their container. Use this method if you want to modify the order.
782 // IMPORTANT NOTE: loops in the focus hierarchy are not supported.
783 void SetNextFocusableView(View* view);
785 // Sets whether this view is capable of taking focus.
786 // Note that this is false by default so that a view used as a container does
787 // not get the focus.
788 void SetFocusable(bool focusable);
790 // Returns true if this view is |focusable_|, |enabled_| and drawn.
791 virtual bool IsFocusable() const;
793 // Return whether this view is focusable when the user requires full keyboard
794 // access, even though it may not be normally focusable.
795 bool IsAccessibilityFocusable() const;
797 // Set whether this view can be made focusable if the user requires
798 // full keyboard access, even though it's not normally focusable.
799 // Note that this is false by default.
800 void SetAccessibilityFocusable(bool accessibility_focusable);
802 // Convenience method to retrieve the FocusManager associated with the
803 // Widget that contains this view. This can return NULL if this view is not
804 // part of a view hierarchy with a Widget.
805 virtual FocusManager* GetFocusManager();
806 virtual const FocusManager* GetFocusManager() const;
808 // Request keyboard focus. The receiving view will become the focused view.
809 virtual void RequestFocus();
811 // Invoked when a view is about to be requested for focus due to the focus
812 // traversal. Reverse is this request was generated going backward
813 // (Shift-Tab).
814 virtual void AboutToRequestFocusFromTabTraversal(bool reverse) {}
816 // Invoked when a key is pressed before the key event is processed (and
817 // potentially eaten) by the focus manager for tab traversal, accelerators and
818 // other focus related actions.
819 // The default implementation returns false, ensuring that tab traversal and
820 // accelerators processing is performed.
821 // Subclasses should return true if they want to process the key event and not
822 // have it processed as an accelerator (if any) or as a tab traversal (if the
823 // key event is for the TAB key). In that case, OnKeyPressed will
824 // subsequently be invoked for that event.
825 virtual bool SkipDefaultKeyEventProcessing(const ui::KeyEvent& event);
827 // Subclasses that contain traversable children that are not directly
828 // accessible through the children hierarchy should return the associated
829 // FocusTraversable for the focus traversal to work properly.
830 virtual FocusTraversable* GetFocusTraversable();
832 // Subclasses that can act as a "pane" must implement their own
833 // FocusTraversable to keep the focus trapped within the pane.
834 // If this method returns an object, any view that's a direct or
835 // indirect child of this view will always use this FocusTraversable
836 // rather than the one from the widget.
837 virtual FocusTraversable* GetPaneFocusTraversable();
839 // Tooltips ------------------------------------------------------------------
841 // Gets the tooltip for this View. If the View does not have a tooltip,
842 // return false. If the View does have a tooltip, copy the tooltip into
843 // the supplied string and return true.
844 // Any time the tooltip text that a View is displaying changes, it must
845 // invoke TooltipTextChanged.
846 // |p| provides the coordinates of the mouse (relative to this view).
847 virtual bool GetTooltipText(const gfx::Point& p,
848 base::string16* tooltip) const;
850 // Returns the location (relative to this View) for the text on the tooltip
851 // to display. If false is returned (the default), the tooltip is placed at
852 // a default position.
853 virtual bool GetTooltipTextOrigin(const gfx::Point& p, gfx::Point* loc) const;
855 // Context menus -------------------------------------------------------------
857 // Sets the ContextMenuController. Setting this to non-null makes the View
858 // process mouse events.
859 ContextMenuController* context_menu_controller() {
860 return context_menu_controller_;
862 void set_context_menu_controller(ContextMenuController* menu_controller) {
863 context_menu_controller_ = menu_controller;
866 // Provides default implementation for context menu handling. The default
867 // implementation calls the ShowContextMenu of the current
868 // ContextMenuController (if it is not NULL). Overridden in subclassed views
869 // to provide right-click menu display triggerd by the keyboard (i.e. for the
870 // Chrome toolbar Back and Forward buttons). No source needs to be specified,
871 // as it is always equal to the current View.
872 virtual void ShowContextMenu(const gfx::Point& p,
873 ui::MenuSourceType source_type);
875 // On some platforms, we show context menu on mouse press instead of release.
876 // This method returns true for those platforms.
877 static bool ShouldShowContextMenuOnMousePress();
879 // Drag and drop -------------------------------------------------------------
881 DragController* drag_controller() { return drag_controller_; }
882 void set_drag_controller(DragController* drag_controller) {
883 drag_controller_ = drag_controller;
886 // During a drag and drop session when the mouse moves the view under the
887 // mouse is queried for the drop types it supports by way of the
888 // GetDropFormats methods. If the view returns true and the drag site can
889 // provide data in one of the formats, the view is asked if the drop data
890 // is required before any other drop events are sent. Once the
891 // data is available the view is asked if it supports the drop (by way of
892 // the CanDrop method). If a view returns true from CanDrop,
893 // OnDragEntered is sent to the view when the mouse first enters the view,
894 // as the mouse moves around within the view OnDragUpdated is invoked.
895 // If the user releases the mouse over the view and OnDragUpdated returns a
896 // valid drop, then OnPerformDrop is invoked. If the mouse moves outside the
897 // view or over another view that wants the drag, OnDragExited is invoked.
899 // Similar to mouse events, the deepest view under the mouse is first checked
900 // if it supports the drop (Drop). If the deepest view under
901 // the mouse does not support the drop, the ancestors are walked until one
902 // is found that supports the drop.
904 // Override and return the set of formats that can be dropped on this view.
905 // |formats| is a bitmask of the formats defined bye OSExchangeData::Format.
906 // The default implementation returns false, which means the view doesn't
907 // support dropping.
908 virtual bool GetDropFormats(
909 int* formats,
910 std::set<OSExchangeData::CustomFormat>* custom_formats);
912 // Override and return true if the data must be available before any drop
913 // methods should be invoked. The default is false.
914 virtual bool AreDropTypesRequired();
916 // A view that supports drag and drop must override this and return true if
917 // data contains a type that may be dropped on this view.
918 virtual bool CanDrop(const OSExchangeData& data);
920 // OnDragEntered is invoked when the mouse enters this view during a drag and
921 // drop session and CanDrop returns true. This is immediately
922 // followed by an invocation of OnDragUpdated, and eventually one of
923 // OnDragExited or OnPerformDrop.
924 virtual void OnDragEntered(const ui::DropTargetEvent& event);
926 // Invoked during a drag and drop session while the mouse is over the view.
927 // This should return a bitmask of the DragDropTypes::DragOperation supported
928 // based on the location of the event. Return 0 to indicate the drop should
929 // not be accepted.
930 virtual int OnDragUpdated(const ui::DropTargetEvent& event);
932 // Invoked during a drag and drop session when the mouse exits the views, or
933 // when the drag session was canceled and the mouse was over the view.
934 virtual void OnDragExited();
936 // Invoked during a drag and drop session when OnDragUpdated returns a valid
937 // operation and the user release the mouse.
938 virtual int OnPerformDrop(const ui::DropTargetEvent& event);
940 // Invoked from DoDrag after the drag completes. This implementation does
941 // nothing, and is intended for subclasses to do cleanup.
942 virtual void OnDragDone();
944 // Returns true if the mouse was dragged enough to start a drag operation.
945 // delta_x and y are the distance the mouse was dragged.
946 static bool ExceededDragThreshold(const gfx::Vector2d& delta);
948 // Accessibility -------------------------------------------------------------
950 // Modifies |state| to reflect the current accessible state of this view.
951 virtual void GetAccessibleState(ui::AXViewState* state) { }
953 // Returns an instance of the native accessibility interface for this view.
954 virtual gfx::NativeViewAccessible GetNativeViewAccessible();
956 // Notifies assistive technology that an accessibility event has
957 // occurred on this view, such as when the view is focused or when its
958 // value changes. Pass true for |send_native_event| except for rare
959 // cases where the view is a native control that's already sending a
960 // native accessibility event and the duplicate event would cause
961 // problems.
962 void NotifyAccessibilityEvent(ui::AXEvent event_type,
963 bool send_native_event);
965 // Scrolling -----------------------------------------------------------------
966 // TODO(beng): Figure out if this can live somewhere other than View, i.e.
967 // closer to ScrollView.
969 // Scrolls the specified region, in this View's coordinate system, to be
970 // visible. View's implementation passes the call onto the parent View (after
971 // adjusting the coordinates). It is up to views that only show a portion of
972 // the child view, such as Viewport, to override appropriately.
973 virtual void ScrollRectToVisible(const gfx::Rect& rect);
975 // The following methods are used by ScrollView to determine the amount
976 // to scroll relative to the visible bounds of the view. For example, a
977 // return value of 10 indicates the scrollview should scroll 10 pixels in
978 // the appropriate direction.
980 // Each method takes the following parameters:
982 // is_horizontal: if true, scrolling is along the horizontal axis, otherwise
983 // the vertical axis.
984 // is_positive: if true, scrolling is by a positive amount. Along the
985 // vertical axis scrolling by a positive amount equates to
986 // scrolling down.
988 // The return value should always be positive and gives the number of pixels
989 // to scroll. ScrollView interprets a return value of 0 (or negative)
990 // to scroll by a default amount.
992 // See VariableRowHeightScrollHelper and FixedRowHeightScrollHelper for
993 // implementations of common cases.
994 virtual int GetPageScrollIncrement(ScrollView* scroll_view,
995 bool is_horizontal, bool is_positive);
996 virtual int GetLineScrollIncrement(ScrollView* scroll_view,
997 bool is_horizontal, bool is_positive);
999 protected:
1000 // Used to track a drag. RootView passes this into
1001 // ProcessMousePressed/Dragged.
1002 struct DragInfo {
1003 // Sets possible_drag to false and start_x/y to 0. This is invoked by
1004 // RootView prior to invoke ProcessMousePressed.
1005 void Reset();
1007 // Sets possible_drag to true and start_pt to the specified point.
1008 // This is invoked by the target view if it detects the press may generate
1009 // a drag.
1010 void PossibleDrag(const gfx::Point& p);
1012 // Whether the press may generate a drag.
1013 bool possible_drag;
1015 // Coordinates of the mouse press.
1016 gfx::Point start_pt;
1019 // Size and disposition ------------------------------------------------------
1021 // Override to be notified when the bounds of the view have changed.
1022 virtual void OnBoundsChanged(const gfx::Rect& previous_bounds);
1024 // Called when the preferred size of a child view changed. This gives the
1025 // parent an opportunity to do a fresh layout if that makes sense.
1026 virtual void ChildPreferredSizeChanged(View* child) {}
1028 // Called when the visibility of a child view changed. This gives the parent
1029 // an opportunity to do a fresh layout if that makes sense.
1030 virtual void ChildVisibilityChanged(View* child) {}
1032 // Invalidates the layout and calls ChildPreferredSizeChanged on the parent
1033 // if there is one. Be sure to call View::PreferredSizeChanged when
1034 // overriding such that the layout is properly invalidated.
1035 virtual void PreferredSizeChanged();
1037 // Override returning true when the view needs to be notified when its visible
1038 // bounds relative to the root view may have changed. Only used by
1039 // NativeViewHost.
1040 virtual bool NeedsNotificationWhenVisibleBoundsChange() const;
1042 // Notification that this View's visible bounds relative to the root view may
1043 // have changed. The visible bounds are the region of the View not clipped by
1044 // its ancestors. This is used for clipping NativeViewHost.
1045 virtual void OnVisibleBoundsChanged();
1047 // Override to be notified when the enabled state of this View has
1048 // changed. The default implementation calls SchedulePaint() on this View.
1049 virtual void OnEnabledChanged();
1051 bool needs_layout() const { return needs_layout_; }
1053 // Tree operations -----------------------------------------------------------
1055 // This method is invoked when the tree changes.
1057 // When a view is removed, it is invoked for all children and grand
1058 // children. For each of these views, a notification is sent to the
1059 // view and all parents.
1061 // When a view is added, a notification is sent to the view, all its
1062 // parents, and all its children (and grand children)
1064 // Default implementation does nothing. Override to perform operations
1065 // required when a view is added or removed from a view hierarchy
1067 // Refer to comments in struct |ViewHierarchyChangedDetails| for |details|.
1068 virtual void ViewHierarchyChanged(const ViewHierarchyChangedDetails& details);
1070 // When SetVisible() changes the visibility of a view, this method is
1071 // invoked for that view as well as all the children recursively.
1072 virtual void VisibilityChanged(View* starting_from, bool is_visible);
1074 // This method is invoked when the parent NativeView of the widget that the
1075 // view is attached to has changed and the view hierarchy has not changed.
1076 // ViewHierarchyChanged() is called when the parent NativeView of the widget
1077 // that the view is attached to is changed as a result of changing the view
1078 // hierarchy. Overriding this method is useful for tracking which
1079 // FocusManager manages this view.
1080 virtual void NativeViewHierarchyChanged();
1082 // Painting ------------------------------------------------------------------
1084 // Responsible for calling Paint() on child Views. Override to control the
1085 // order child Views are painted.
1086 virtual void PaintChildren(gfx::Canvas* canvas, const CullSet& cull_set);
1088 // Override to provide rendering in any part of the View's bounds. Typically
1089 // this is the "contents" of the view. If you override this method you will
1090 // have to call the subsequent OnPaint*() methods manually.
1091 virtual void OnPaint(gfx::Canvas* canvas);
1093 // Override to paint a background before any content is drawn. Typically this
1094 // is done if you are satisfied with a default OnPaint handler but wish to
1095 // supply a different background.
1096 virtual void OnPaintBackground(gfx::Canvas* canvas);
1098 // Override to paint a border not specified by SetBorder().
1099 virtual void OnPaintBorder(gfx::Canvas* canvas);
1101 // Returns true if this View is the root for paint events, and should
1102 // therefore maintain a |bounds_tree_| member and use it for paint damage rect
1103 // calculations.
1104 virtual bool IsPaintRoot();
1106 // Accelerated painting ------------------------------------------------------
1108 // Returns the offset from this view to the nearest ancestor with a layer. If
1109 // |layer_parent| is non-NULL it is set to the nearest ancestor with a layer.
1110 virtual gfx::Vector2d CalculateOffsetToAncestorWithLayer(
1111 ui::Layer** layer_parent);
1113 // Updates the view's layer's parent. Called when a view is added to a view
1114 // hierarchy, responsible for parenting the view's layer to the enclosing
1115 // layer in the hierarchy.
1116 virtual void UpdateParentLayer();
1118 // If this view has a layer, the layer is reparented to |parent_layer| and its
1119 // bounds is set based on |point|. If this view does not have a layer, then
1120 // recurses through all children. This is used when adding a layer to an
1121 // existing view to make sure all descendants that have layers are parented to
1122 // the right layer.
1123 void MoveLayerToParent(ui::Layer* parent_layer, const gfx::Point& point);
1125 // Called to update the bounds of any child layers within this View's
1126 // hierarchy when something happens to the hierarchy.
1127 void UpdateChildLayerBounds(const gfx::Vector2d& offset);
1129 // Overridden from ui::LayerDelegate:
1130 virtual void OnPaintLayer(gfx::Canvas* canvas) OVERRIDE;
1131 virtual void OnDeviceScaleFactorChanged(float device_scale_factor) OVERRIDE;
1132 virtual base::Closure PrepareForLayerBoundsChange() OVERRIDE;
1134 // Finds the layer that this view paints to (it may belong to an ancestor
1135 // view), then reorders the immediate children of that layer to match the
1136 // order of the view tree.
1137 virtual void ReorderLayers();
1139 // This reorders the immediate children of |*parent_layer| to match the
1140 // order of the view tree. Child layers which are owned by a view are
1141 // reordered so that they are below any child layers not owned by a view.
1142 // Widget::ReorderNativeViews() should be called to reorder any child layers
1143 // with an associated view. Widget::ReorderNativeViews() may reorder layers
1144 // below layers owned by a view.
1145 virtual void ReorderChildLayers(ui::Layer* parent_layer);
1147 // Input ---------------------------------------------------------------------
1149 // Called by HitTestRect() to see if this View has a custom hit test mask. If
1150 // the return value is true, GetHitTestMask() will be called to obtain the
1151 // mask. Default value is false, in which case the View will hit-test against
1152 // its bounds.
1153 virtual bool HasHitTestMask() const;
1155 // Called by HitTestRect() to retrieve a mask for hit-testing against.
1156 // Subclasses override to provide custom shaped hit test regions.
1157 // TODO(tdanderson): Remove this method once Tab, TabCloseButton,
1158 // NewTabButton, and MicButton all implement
1159 // MaskedViewTargeter.
1160 virtual void GetHitTestMaskDeprecated(HitTestSource source,
1161 gfx::Path* mask) const;
1163 virtual DragInfo* GetDragInfo();
1165 // Focus ---------------------------------------------------------------------
1167 // Returns last value passed to SetFocusable(). Use IsFocusable() to determine
1168 // if a view can take focus right now.
1169 bool focusable() const { return focusable_; }
1171 // Override to be notified when focus has changed either to or from this View.
1172 virtual void OnFocus();
1173 virtual void OnBlur();
1175 // Handle view focus/blur events for this view.
1176 void Focus();
1177 void Blur();
1179 // System events -------------------------------------------------------------
1181 // Called when the UI theme (not the NativeTheme) has changed, overriding
1182 // allows individual Views to do special cleanup and processing (such as
1183 // dropping resource caches). To dispatch a theme changed notification, call
1184 // Widget::ThemeChanged().
1185 virtual void OnThemeChanged() {}
1187 // Called when the locale has changed, overriding allows individual Views to
1188 // update locale-dependent strings.
1189 // To dispatch a locale changed notification, call Widget::LocaleChanged().
1190 virtual void OnLocaleChanged() {}
1192 // Tooltips ------------------------------------------------------------------
1194 // Views must invoke this when the tooltip text they are to display changes.
1195 void TooltipTextChanged();
1197 // Context menus -------------------------------------------------------------
1199 // Returns the location, in screen coordinates, to show the context menu at
1200 // when the context menu is shown from the keyboard. This implementation
1201 // returns the middle of the visible region of this view.
1203 // This method is invoked when the context menu is shown by way of the
1204 // keyboard.
1205 virtual gfx::Point GetKeyboardContextMenuLocation();
1207 // Drag and drop -------------------------------------------------------------
1209 // These are cover methods that invoke the method of the same name on
1210 // the DragController. Subclasses may wish to override rather than install
1211 // a DragController.
1212 // See DragController for a description of these methods.
1213 virtual int GetDragOperations(const gfx::Point& press_pt);
1214 virtual void WriteDragData(const gfx::Point& press_pt, OSExchangeData* data);
1216 // Returns whether we're in the middle of a drag session that was initiated
1217 // by us.
1218 bool InDrag();
1220 // Returns how much the mouse needs to move in one direction to start a
1221 // drag. These methods cache in a platform-appropriate way. These values are
1222 // used by the public static method ExceededDragThreshold().
1223 static int GetHorizontalDragThreshold();
1224 static int GetVerticalDragThreshold();
1226 // NativeTheme ---------------------------------------------------------------
1228 // Invoked when the NativeTheme associated with this View changes.
1229 virtual void OnNativeThemeChanged(const ui::NativeTheme* theme) {}
1231 // Debugging -----------------------------------------------------------------
1233 #if !defined(NDEBUG)
1234 // Returns string containing a graph of the views hierarchy in graphViz DOT
1235 // language (http://graphviz.org/). Can be called within debugger and save
1236 // to a file to compile/view.
1237 // Note: Assumes initial call made with first = true.
1238 virtual std::string PrintViewGraph(bool first);
1240 // Some classes may own an object which contains the children to displayed in
1241 // the views hierarchy. The above function gives the class the flexibility to
1242 // decide which object should be used to obtain the children, but this
1243 // function makes the decision explicit.
1244 std::string DoPrintViewGraph(bool first, View* view_with_children);
1245 #endif
1247 private:
1248 friend class internal::PreEventDispatchHandler;
1249 friend class internal::PostEventDispatchHandler;
1250 friend class internal::RootView;
1251 friend class FocusManager;
1252 friend class Widget;
1254 typedef gfx::RTree<intptr_t> BoundsTree;
1256 // Painting -----------------------------------------------------------------
1258 enum SchedulePaintType {
1259 // Indicates the size is the same (only the origin changed).
1260 SCHEDULE_PAINT_SIZE_SAME,
1262 // Indicates the size changed (and possibly the origin).
1263 SCHEDULE_PAINT_SIZE_CHANGED
1266 // Invoked before and after the bounds change to schedule painting the old and
1267 // new bounds.
1268 void SchedulePaintBoundsChanged(SchedulePaintType type);
1270 // Common Paint() code shared by accelerated and non-accelerated code paths to
1271 // invoke OnPaint() on the View.
1272 void PaintCommon(gfx::Canvas* canvas, const CullSet& cull_set);
1274 // Tree operations -----------------------------------------------------------
1276 // Removes |view| from the hierarchy tree. If |update_focus_cycle| is true,
1277 // the next and previous focusable views of views pointing to this view are
1278 // updated. If |update_tool_tip| is true, the tooltip is updated. If
1279 // |delete_removed_view| is true, the view is also deleted (if it is parent
1280 // owned). If |new_parent| is not NULL, the remove is the result of
1281 // AddChildView() to a new parent. For this case, |new_parent| is the View
1282 // that |view| is going to be added to after the remove completes.
1283 void DoRemoveChildView(View* view,
1284 bool update_focus_cycle,
1285 bool update_tool_tip,
1286 bool delete_removed_view,
1287 View* new_parent);
1289 // Call ViewHierarchyChanged() for all child views and all parents.
1290 // |old_parent| is the original parent of the View that was removed.
1291 // If |new_parent| is not NULL, the View that was removed will be reparented
1292 // to |new_parent| after the remove operation.
1293 void PropagateRemoveNotifications(View* old_parent, View* new_parent);
1295 // Call ViewHierarchyChanged() for all children.
1296 void PropagateAddNotifications(const ViewHierarchyChangedDetails& details);
1298 // Propagates NativeViewHierarchyChanged() notification through all the
1299 // children.
1300 void PropagateNativeViewHierarchyChanged();
1302 // Takes care of registering/unregistering accelerators if
1303 // |register_accelerators| true and calls ViewHierarchyChanged().
1304 void ViewHierarchyChangedImpl(bool register_accelerators,
1305 const ViewHierarchyChangedDetails& details);
1307 // Invokes OnNativeThemeChanged() on this and all descendants.
1308 void PropagateNativeThemeChanged(const ui::NativeTheme* theme);
1310 // Size and disposition ------------------------------------------------------
1312 // Call VisibilityChanged() recursively for all children.
1313 void PropagateVisibilityNotifications(View* from, bool is_visible);
1315 // Registers/unregisters accelerators as necessary and calls
1316 // VisibilityChanged().
1317 void VisibilityChangedImpl(View* starting_from, bool is_visible);
1319 // Responsible for propagating bounds change notifications to relevant
1320 // views.
1321 void BoundsChanged(const gfx::Rect& previous_bounds);
1323 // Visible bounds notification registration.
1324 // When a view is added to a hierarchy, it and all its children are asked if
1325 // they need to be registered for "visible bounds within root" notifications
1326 // (see comment on OnVisibleBoundsChanged()). If they do, they are registered
1327 // with every ancestor between them and the root of the hierarchy.
1328 static void RegisterChildrenForVisibleBoundsNotification(View* view);
1329 static void UnregisterChildrenForVisibleBoundsNotification(View* view);
1330 void RegisterForVisibleBoundsNotification();
1331 void UnregisterForVisibleBoundsNotification();
1333 // Adds/removes view to the list of descendants that are notified any time
1334 // this views location and possibly size are changed.
1335 void AddDescendantToNotify(View* view);
1336 void RemoveDescendantToNotify(View* view);
1338 // Sets the layer's bounds given in DIP coordinates.
1339 void SetLayerBounds(const gfx::Rect& bounds_in_dip);
1341 // Sets the bit indicating that the cached bounds for this object within the
1342 // root view bounds tree are no longer valid. If |origin_changed| is true sets
1343 // the same bit for all of our children as well.
1344 void SetRootBoundsDirty(bool origin_changed);
1346 // If needed, updates the bounds rectangle in paint root coordinate space
1347 // in the supplied RTree. Recurses to children for recomputation as well.
1348 void UpdateRootBounds(BoundsTree* bounds_tree, const gfx::Vector2d& offset);
1350 // Remove self and all children from the supplied bounds tree. This is used,
1351 // for example, when a view gets a layer and therefore becomes paint root. It
1352 // needs to remove all references to itself and its children from any previous
1353 // paint root that may have been tracking it.
1354 void RemoveRootBounds(BoundsTree* bounds_tree);
1356 // Traverse up the View hierarchy to the first ancestor that is a paint root
1357 // and return a pointer to its |bounds_tree_| or NULL if no tree is found.
1358 BoundsTree* GetBoundsTreeFromPaintRoot();
1360 // Transformations -----------------------------------------------------------
1362 // Returns in |transform| the transform to get from coordinates of |ancestor|
1363 // to this. Returns true if |ancestor| is found. If |ancestor| is not found,
1364 // or NULL, |transform| is set to convert from root view coordinates to this.
1365 bool GetTransformRelativeTo(const View* ancestor,
1366 gfx::Transform* transform) const;
1368 // Coordinate conversion -----------------------------------------------------
1370 // Convert a point in the view's coordinate to an ancestor view's coordinate
1371 // system using necessary transformations. Returns whether the point was
1372 // successfully converted to the ancestor's coordinate system.
1373 bool ConvertPointForAncestor(const View* ancestor, gfx::Point* point) const;
1375 // Convert a point in the ancestor's coordinate system to the view's
1376 // coordinate system using necessary transformations. Returns whether the
1377 // point was successfully converted from the ancestor's coordinate system
1378 // to the view's coordinate system.
1379 bool ConvertPointFromAncestor(const View* ancestor, gfx::Point* point) const;
1381 // Convert a rect in the view's coordinate to an ancestor view's coordinate
1382 // system using necessary transformations. Returns whether the rect was
1383 // successfully converted to the ancestor's coordinate system.
1384 bool ConvertRectForAncestor(const View* ancestor, gfx::RectF* rect) const;
1386 // Convert a rect in the ancestor's coordinate system to the view's
1387 // coordinate system using necessary transformations. Returns whether the
1388 // rect was successfully converted from the ancestor's coordinate system
1389 // to the view's coordinate system.
1390 bool ConvertRectFromAncestor(const View* ancestor, gfx::RectF* rect) const;
1392 // Accelerated painting ------------------------------------------------------
1394 // Creates the layer and related fields for this view.
1395 void CreateLayer();
1397 // Parents all un-parented layers within this view's hierarchy to this view's
1398 // layer.
1399 void UpdateParentLayers();
1401 // Parents this view's layer to |parent_layer|, and sets its bounds and other
1402 // properties in accordance to |offset|, the view's offset from the
1403 // |parent_layer|.
1404 void ReparentLayer(const gfx::Vector2d& offset, ui::Layer* parent_layer);
1406 // Called to update the layer visibility. The layer will be visible if the
1407 // View itself, and all its parent Views are visible. This also updates
1408 // visibility of the child layers.
1409 void UpdateLayerVisibility();
1410 void UpdateChildLayerVisibility(bool visible);
1412 // Orphans the layers in this subtree that are parented to layers outside of
1413 // this subtree.
1414 void OrphanLayers();
1416 // Destroys the layer associated with this view, and reparents any descendants
1417 // to the destroyed layer's parent.
1418 void DestroyLayer();
1420 // Input ---------------------------------------------------------------------
1422 bool ProcessMousePressed(const ui::MouseEvent& event);
1423 bool ProcessMouseDragged(const ui::MouseEvent& event);
1424 void ProcessMouseReleased(const ui::MouseEvent& event);
1426 // Accelerators --------------------------------------------------------------
1428 // Registers this view's keyboard accelerators that are not registered to
1429 // FocusManager yet, if possible.
1430 void RegisterPendingAccelerators();
1432 // Unregisters all the keyboard accelerators associated with this view.
1433 // |leave_data_intact| if true does not remove data from accelerators_ array,
1434 // so it could be re-registered with other focus manager
1435 void UnregisterAccelerators(bool leave_data_intact);
1437 // Focus ---------------------------------------------------------------------
1439 // Initialize the previous/next focusable views of the specified view relative
1440 // to the view at the specified index.
1441 void InitFocusSiblings(View* view, int index);
1443 // System events -------------------------------------------------------------
1445 // Used to propagate theme changed notifications from the root view to all
1446 // views in the hierarchy.
1447 virtual void PropagateThemeChanged();
1449 // Used to propagate locale changed notifications from the root view to all
1450 // views in the hierarchy.
1451 virtual void PropagateLocaleChanged();
1453 // Tooltips ------------------------------------------------------------------
1455 // Propagates UpdateTooltip() to the TooltipManager for the Widget.
1456 // This must be invoked any time the View hierarchy changes in such a way
1457 // the view under the mouse differs. For example, if the bounds of a View is
1458 // changed, this is invoked. Similarly, as Views are added/removed, this
1459 // is invoked.
1460 void UpdateTooltip();
1462 // Drag and drop -------------------------------------------------------------
1464 // Starts a drag and drop operation originating from this view. This invokes
1465 // WriteDragData to write the data and GetDragOperations to determine the
1466 // supported drag operations. When done, OnDragDone is invoked. |press_pt| is
1467 // in the view's coordinate system.
1468 // Returns true if a drag was started.
1469 bool DoDrag(const ui::LocatedEvent& event,
1470 const gfx::Point& press_pt,
1471 ui::DragDropTypes::DragEventSource source);
1473 //////////////////////////////////////////////////////////////////////////////
1475 // Creation and lifetime -----------------------------------------------------
1477 // False if this View is owned by its parent - i.e. it will be deleted by its
1478 // parent during its parents destruction. False is the default.
1479 bool owned_by_client_;
1481 // Attributes ----------------------------------------------------------------
1483 // The id of this View. Used to find this View.
1484 int id_;
1486 // The group of this view. Some view subclasses use this id to find other
1487 // views of the same group. For example radio button uses this information
1488 // to find other radio buttons.
1489 int group_;
1491 // Tree operations -----------------------------------------------------------
1493 // This view's parent.
1494 View* parent_;
1496 // This view's children.
1497 Views children_;
1499 // Size and disposition ------------------------------------------------------
1501 // This View's bounds in the parent coordinate system.
1502 gfx::Rect bounds_;
1504 // Whether this view is visible.
1505 bool visible_;
1507 // Whether this view is enabled.
1508 bool enabled_;
1510 // When this flag is on, a View receives a mouse-enter and mouse-leave event
1511 // even if a descendant View is the event-recipient for the real mouse
1512 // events. When this flag is turned on, and mouse moves from outside of the
1513 // view into a child view, both the child view and this view receives
1514 // mouse-enter event. Similarly, if the mouse moves from inside a child view
1515 // and out of this view, then both views receive a mouse-leave event.
1516 // When this flag is turned off, if the mouse moves from inside this view into
1517 // a child view, then this view receives a mouse-leave event. When this flag
1518 // is turned on, it does not receive the mouse-leave event in this case.
1519 // When the mouse moves from inside the child view out of the child view but
1520 // still into this view, this view receives a mouse-enter event if this flag
1521 // is turned off, but doesn't if this flag is turned on.
1522 // This flag is initialized to false.
1523 bool notify_enter_exit_on_child_;
1525 // Whether or not RegisterViewForVisibleBoundsNotification on the RootView
1526 // has been invoked.
1527 bool registered_for_visible_bounds_notification_;
1529 // List of descendants wanting notification when their visible bounds change.
1530 scoped_ptr<Views> descendants_to_notify_;
1532 // True if the bounds on this object have changed since the last time the
1533 // paint root view constructed the spatial database.
1534 bool root_bounds_dirty_;
1536 // If this View IsPaintRoot() then this will be a pointer to a spatial data
1537 // structure where we will keep the bounding boxes of all our children, for
1538 // efficient paint damage rectangle intersection.
1539 scoped_ptr<BoundsTree> bounds_tree_;
1541 // Transformations -----------------------------------------------------------
1543 // Clipping parameters. skia transformation matrix does not give us clipping.
1544 // So we do it ourselves.
1545 gfx::Insets clip_insets_;
1547 // Layout --------------------------------------------------------------------
1549 // Whether the view needs to be laid out.
1550 bool needs_layout_;
1552 // The View's LayoutManager defines the sizing heuristics applied to child
1553 // Views. The default is absolute positioning according to bounds_.
1554 scoped_ptr<LayoutManager> layout_manager_;
1556 // Painting ------------------------------------------------------------------
1558 // Background
1559 scoped_ptr<Background> background_;
1561 // Border.
1562 scoped_ptr<Border> border_;
1564 // RTL painting --------------------------------------------------------------
1566 // Indicates whether or not the gfx::Canvas object passed to View::Paint()
1567 // is going to be flipped horizontally (using the appropriate transform) on
1568 // right-to-left locales for this View.
1569 bool flip_canvas_on_paint_for_rtl_ui_;
1571 // Accelerated painting ------------------------------------------------------
1573 bool paint_to_layer_;
1575 // Accelerators --------------------------------------------------------------
1577 // Focus manager accelerators registered on.
1578 FocusManager* accelerator_focus_manager_;
1580 // The list of accelerators. List elements in the range
1581 // [0, registered_accelerator_count_) are already registered to FocusManager,
1582 // and the rest are not yet.
1583 scoped_ptr<std::vector<ui::Accelerator> > accelerators_;
1584 size_t registered_accelerator_count_;
1586 // Focus ---------------------------------------------------------------------
1588 // Next view to be focused when the Tab key is pressed.
1589 View* next_focusable_view_;
1591 // Next view to be focused when the Shift-Tab key combination is pressed.
1592 View* previous_focusable_view_;
1594 // Whether this view can be focused.
1595 bool focusable_;
1597 // Whether this view is focusable if the user requires full keyboard access,
1598 // even though it may not be normally focusable.
1599 bool accessibility_focusable_;
1601 // Context menus -------------------------------------------------------------
1603 // The menu controller.
1604 ContextMenuController* context_menu_controller_;
1606 // Drag and drop -------------------------------------------------------------
1608 DragController* drag_controller_;
1610 // Input --------------------------------------------------------------------
1612 scoped_ptr<ViewTargeter> targeter_;
1614 // Accessibility -------------------------------------------------------------
1616 // Belongs to this view, but it's reference-counted on some platforms
1617 // so we can't use a scoped_ptr. It's dereferenced in the destructor.
1618 NativeViewAccessibility* native_view_accessibility_;
1620 DISALLOW_COPY_AND_ASSIGN(View);
1623 } // namespace views
1625 #endif // UI_VIEWS_VIEW_H_