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_
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/base/accelerators/accelerator.h"
20 #include "ui/base/accessibility/accessibility_types.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/native_widget_types.h"
30 #include "ui/gfx/rect.h"
31 #include "ui/gfx/vector2d.h"
32 #include "ui/views/background.h"
33 #include "ui/views/border.h"
34 #include "ui/views/focus_border.h"
37 #include "base/win/scoped_comptr.h"
40 using ui::OSExchangeData;
50 struct AccessibleViewState;
54 class TextInputClient;
63 class ContextMenuController;
67 class FocusTraversable;
70 class NativeViewAccessibility;
75 class PostEventDispatchHandler;
79 /////////////////////////////////////////////////////////////////////////////
83 // A View is a rectangle within the views View hierarchy. It is the base
84 // class for all Views.
86 // A View is a container of other Views (there is no such thing as a Leaf
87 // View - makes code simpler, reduces type conversion headaches, design
90 // The View contains basic properties for sizing (bounds), layout (flex,
91 // orientation, etc), painting of children and event dispatch.
93 // The View also uses a simple Box Layout Manager similar to XUL's
94 // SprocketLayout system. Alternative Layout Managers implementing the
95 // LayoutManager interface can be used to lay out children if required.
97 // It is up to the subclass to implement Painting and storage of subclass -
98 // specific properties and functionality.
100 // Unless otherwise documented, views is not thread safe and should only be
101 // accessed from the main thread.
103 /////////////////////////////////////////////////////////////////////////////
104 class VIEWS_EXPORT View : public ui::LayerDelegate,
105 public ui::LayerOwner,
106 public ui::AcceleratorTarget,
107 public ui::EventTarget {
109 typedef std::vector<View*> Views;
111 // TODO(tdanderson,sadrul): Becomes obsolete with the refactoring of the
112 // event targeting logic for views and windows.
113 // Specifies the source of the region used in a hit test.
114 // HIT_TEST_SOURCE_MOUSE indicates the hit test is being performed with a
115 // single point and HIT_TEST_SOURCE_TOUCH indicates the hit test is being
116 // performed with a rect larger than a single point. This value can be used,
117 // for example, to add extra padding or change the shape of the hit test mask.
119 HIT_TEST_SOURCE_MOUSE,
120 HIT_TEST_SOURCE_TOUCH
123 struct ViewHierarchyChangedDetails {
124 ViewHierarchyChangedDetails()
130 ViewHierarchyChangedDetails(bool is_add,
137 move_view(move_view) {}
140 // New parent if |is_add| is true, old parent if |is_add| is false.
142 // The view being added or removed.
144 // If this is a move (reparent), meaning AddChildViewAt() is invoked with an
145 // existing parent, then a notification for the remove is sent first,
146 // followed by one for the add. This case can be distinguished by a
147 // non-NULL |move_view|.
148 // For the remove part of move, |move_view| is the new parent of the View
150 // For the add part of move, |move_view| is the old parent of the View being
155 // Creation and lifetime -----------------------------------------------------
160 // By default a View is owned by its parent unless specified otherwise here.
161 void set_owned_by_client() { owned_by_client_ = true; }
163 // Tree operations -----------------------------------------------------------
165 // Get the Widget that hosts this View, if any.
166 virtual const Widget* GetWidget() const;
167 virtual Widget* GetWidget();
169 // Adds |view| as a child of this view, optionally at |index|.
170 void AddChildView(View* view);
171 void AddChildViewAt(View* view, int index);
173 // Moves |view| to the specified |index|. A negative value for |index| moves
174 // the view at the end.
175 void ReorderChildView(View* view, int index);
177 // Removes |view| from this view. The view's parent will change to NULL.
178 void RemoveChildView(View* view);
180 // Removes all the children from this view. If |delete_children| is true,
181 // the views are deleted, unless marked as not parent owned.
182 void RemoveAllChildViews(bool delete_children);
184 int child_count() const { return static_cast<int>(children_.size()); }
185 bool has_children() const { return !children_.empty(); }
187 // Returns the child view at |index|.
188 const View* child_at(int index) const {
190 DCHECK_LT(index, child_count());
191 return children_[index];
193 View* child_at(int index) {
194 return const_cast<View*>(const_cast<const View*>(this)->child_at(index));
197 // Returns the parent view.
198 const View* parent() const { return parent_; }
199 View* parent() { return parent_; }
201 // Returns true if |view| is contained within this View's hierarchy, even as
202 // an indirect descendant. Will return true if child is also this view.
203 bool Contains(const View* view) const;
205 // Returns the index of |view|, or -1 if |view| is not a child of this view.
206 int GetIndexOf(const View* view) const;
208 // Size and disposition ------------------------------------------------------
209 // Methods for obtaining and modifying the position and size of the view.
210 // Position is in the coordinate system of the view's parent.
211 // Position is NOT flipped for RTL. See "RTL positioning" for RTL-sensitive
212 // position accessors.
213 // Transformations are not applied on the size/position. For example, if
214 // bounds is (0, 0, 100, 100) and it is scaled by 0.5 along the X axis, the
215 // width will still be 100 (although when painted, it will be 50x50, painted
216 // at location (0, 0)).
218 void SetBounds(int x, int y, int width, int height);
219 void SetBoundsRect(const gfx::Rect& bounds);
220 void SetSize(const gfx::Size& size);
221 void SetPosition(const gfx::Point& position);
225 // No transformation is applied on the size or the locations.
226 const gfx::Rect& bounds() const { return bounds_; }
227 int x() const { return bounds_.x(); }
228 int y() const { return bounds_.y(); }
229 int width() const { return bounds_.width(); }
230 int height() const { return bounds_.height(); }
231 const gfx::Size& size() const { return bounds_.size(); }
233 // Returns the bounds of the content area of the view, i.e. the rectangle
234 // enclosed by the view's border.
235 gfx::Rect GetContentsBounds() const;
237 // Returns the bounds of the view in its own coordinates (i.e. position is
239 gfx::Rect GetLocalBounds() const;
241 // Returns the bounds of the layer in its own pixel coordinates.
242 gfx::Rect GetLayerBoundsInPixel() const;
244 // Returns the insets of the current border. If there is no border an empty
245 // insets is returned.
246 virtual gfx::Insets GetInsets() const;
248 // Returns the visible bounds of the receiver in the receivers coordinate
251 // When traversing the View hierarchy in order to compute the bounds, the
252 // function takes into account the mirroring setting and transformation for
253 // each View and therefore it will return the mirrored and transformed version
254 // of the visible bounds if need be.
255 gfx::Rect GetVisibleBounds() const;
257 // Return the bounds of the View in screen coordinate system.
258 gfx::Rect GetBoundsInScreen() const;
260 // Returns the baseline of this view, or -1 if this view has no baseline. The
261 // return value is relative to the preferred height.
262 virtual int GetBaseline() const;
264 // Get the size the View would like to be, if enough space were available.
265 virtual gfx::Size GetPreferredSize();
267 // Convenience method that sizes this view to its preferred size.
268 void SizeToPreferredSize();
270 // Gets the minimum size of the view. View's implementation invokes
272 virtual gfx::Size GetMinimumSize();
274 // Gets the maximum size of the view. Currently only used for sizing shell
276 virtual gfx::Size GetMaximumSize();
278 // Return the height necessary to display this view with the provided width.
279 // View's implementation returns the value from getPreferredSize.cy.
280 // Override if your View's preferred height depends upon the width (such
282 virtual int GetHeightForWidth(int w);
284 // Set whether this view is visible. Painting is scheduled as needed.
285 virtual void SetVisible(bool visible);
287 // Return whether a view is visible
288 bool visible() const { return visible_; }
290 // Returns true if this view is drawn on screen.
291 virtual bool IsDrawn() const;
293 // Set whether this view is enabled. A disabled view does not receive keyboard
294 // or mouse inputs. If |enabled| differs from the current value, SchedulePaint
296 void SetEnabled(bool enabled);
298 // Returns whether the view is enabled.
299 bool enabled() const { return enabled_; }
301 // This indicates that the view completely fills its bounds in an opaque
302 // color. This doesn't affect compositing but is a hint to the compositor to
303 // optimize painting.
304 // Note that this method does not implicitly create a layer if one does not
305 // already exist for the View, but is a no-op in that case.
306 void SetFillsBoundsOpaquely(bool fills_bounds_opaquely);
308 // Transformations -----------------------------------------------------------
310 // Methods for setting transformations for a view (e.g. rotation, scaling).
312 gfx::Transform GetTransform() const;
314 // Clipping parameters. Clipping is done relative to the view bounds.
315 void set_clip_insets(gfx::Insets clip_insets) { clip_insets_ = clip_insets; }
317 // Sets the transform to the supplied transform.
318 void SetTransform(const gfx::Transform& transform);
320 // Sets whether this view paints to a layer. A view paints to a layer if
321 // either of the following are true:
322 // . the view has a non-identity transform.
323 // . SetPaintToLayer(true) has been invoked.
324 // View creates the Layer only when it exists in a Widget with a non-NULL
326 void SetPaintToLayer(bool paint_to_layer);
328 // Recreates a layer for the view and returns the old layer. After this call,
329 // the View no longer has a pointer to the old layer (so it won't be able to
330 // update the old layer or destroy it). The caller must free the returned
332 // Returns NULL and does not recreate layer if view does not own its layer.
333 ui::Layer* RecreateLayer() WARN_UNUSED_RESULT;
335 // RTL positioning -----------------------------------------------------------
337 // Methods for accessing the bounds and position of the view, relative to its
338 // parent. The position returned is mirrored if the parent view is using a RTL
341 // NOTE: in the vast majority of the cases, the mirroring implementation is
342 // transparent to the View subclasses and therefore you should use the
343 // bounds() accessor instead.
344 gfx::Rect GetMirroredBounds() const;
345 gfx::Point GetMirroredPosition() const;
346 int GetMirroredX() const;
348 // Given a rectangle specified in this View's coordinate system, the function
349 // computes the 'left' value for the mirrored rectangle within this View. If
350 // the View's UI layout is not right-to-left, then bounds.x() is returned.
352 // UI mirroring is transparent to most View subclasses and therefore there is
353 // no need to call this routine from anywhere within your subclass
355 int GetMirroredXForRect(const gfx::Rect& rect) const;
357 // Given the X coordinate of a point inside the View, this function returns
358 // the mirrored X coordinate of the point if the View's UI layout is
359 // right-to-left. If the layout is left-to-right, the same X coordinate is
362 // Following are a few examples of the values returned by this function for
363 // a View with the bounds {0, 0, 100, 100} and a right-to-left layout:
365 // GetMirroredXCoordinateInView(0) -> 100
366 // GetMirroredXCoordinateInView(20) -> 80
367 // GetMirroredXCoordinateInView(99) -> 1
368 int GetMirroredXInView(int x) const;
370 // Given a X coordinate and a width inside the View, this function returns
371 // the mirrored X coordinate if the View's UI layout is right-to-left. If the
372 // layout is left-to-right, the same X coordinate is returned.
374 // Following are a few examples of the values returned by this function for
375 // a View with the bounds {0, 0, 100, 100} and a right-to-left layout:
377 // GetMirroredXCoordinateInView(0, 10) -> 90
378 // GetMirroredXCoordinateInView(20, 20) -> 60
379 int GetMirroredXWithWidthInView(int x, int w) const;
381 // Layout --------------------------------------------------------------------
383 // Lay out the child Views (set their bounds based on sizing heuristics
384 // specific to the current Layout Manager)
385 virtual void Layout();
387 // TODO(beng): I think we should remove this.
388 // Mark this view and all parents to require a relayout. This ensures the
389 // next call to Layout() will propagate to this view, even if the bounds of
390 // parent views do not change.
391 void InvalidateLayout();
393 // Gets/Sets the Layout Manager used by this view to size and place its
395 // The LayoutManager is owned by the View and is deleted when the view is
396 // deleted, or when a new LayoutManager is installed.
397 LayoutManager* GetLayoutManager() const;
398 void SetLayoutManager(LayoutManager* layout);
400 // Attributes ----------------------------------------------------------------
402 // The view class name.
403 static const char kViewClassName[];
405 // Return the receiving view's class name. A view class is a string which
406 // uniquely identifies the view class. It is intended to be used as a way to
407 // find out during run time if a view can be safely casted to a specific view
408 // subclass. The default implementation returns kViewClassName.
409 virtual const char* GetClassName() const;
411 // Returns the first ancestor, starting at this, whose class name is |name|.
412 // Returns null if no ancestor has the class name |name|.
413 View* GetAncestorWithClassName(const std::string& name);
415 // Recursively descends the view tree starting at this view, and returns
416 // the first child that it encounters that has the given ID.
417 // Returns NULL if no matching child view is found.
418 virtual const View* GetViewByID(int id) const;
419 virtual View* GetViewByID(int id);
421 // Gets and sets the ID for this view. ID should be unique within the subtree
422 // that you intend to search for it. 0 is the default ID for views.
423 int id() const { return id_; }
424 void set_id(int id) { id_ = id; }
426 // A group id is used to tag views which are part of the same logical group.
427 // Focus can be moved between views with the same group using the arrow keys.
428 // Groups are currently used to implement radio button mutual exclusion.
429 // The group id is immutable once it's set.
430 void SetGroup(int gid);
431 // Returns the group id of the view, or -1 if the id is not set yet.
432 int GetGroup() const;
434 // If this returns true, the views from the same group can each be focused
435 // when moving focus with the Tab/Shift-Tab key. If this returns false,
436 // only the selected view from the group (obtained with
437 // GetSelectedViewForGroup()) is focused.
438 virtual bool IsGroupFocusTraversable() const;
440 // Fills |views| with all the available views which belong to the provided
442 void GetViewsInGroup(int group, Views* views);
444 // Returns the View that is currently selected in |group|.
445 // The default implementation simply returns the first View found for that
447 virtual View* GetSelectedViewForGroup(int group);
449 // Coordinate conversion -----------------------------------------------------
451 // Note that the utility coordinate conversions functions always operate on
452 // the mirrored position of the child Views if the parent View uses a
453 // right-to-left UI layout.
455 // Convert a point from the coordinate system of one View to another.
457 // |source| and |target| must be in the same widget, but doesn't need to be in
458 // the same view hierarchy.
459 // |source| can be NULL in which case it means the screen coordinate system.
460 static void ConvertPointToTarget(const View* source,
464 // Convert |rect| from the coordinate system of |source| to the coordinate
465 // system of |target|.
467 // |source| and |target| must be in the same widget, but doesn't need to be in
468 // the same view hierarchy.
469 // |source| can be NULL in which case it means the screen coordinate system.
470 static void ConvertRectToTarget(const View* source,
474 // Convert a point from a View's coordinate system to that of its Widget.
475 static void ConvertPointToWidget(const View* src, gfx::Point* point);
477 // Convert a point from the coordinate system of a View's Widget to that
478 // View's coordinate system.
479 static void ConvertPointFromWidget(const View* dest, gfx::Point* p);
481 // Convert a point from a View's coordinate system to that of the screen.
482 static void ConvertPointToScreen(const View* src, gfx::Point* point);
484 // Convert a point from a View's coordinate system to that of the screen.
485 static void ConvertPointFromScreen(const View* dst, gfx::Point* point);
487 // Applies transformation on the rectangle, which is in the view's coordinate
488 // system, to convert it into the parent's coordinate system.
489 gfx::Rect ConvertRectToParent(const gfx::Rect& rect) const;
491 // Converts a rectangle from this views coordinate system to its widget
492 // coordinate system.
493 gfx::Rect ConvertRectToWidget(const gfx::Rect& rect) const;
495 // Painting ------------------------------------------------------------------
497 // Mark all or part of the View's bounds as dirty (needing repaint).
498 // |r| is in the View's coordinates.
499 // Rectangle |r| should be in the view's coordinate system. The
500 // transformations are applied to it to convert it into the parent coordinate
501 // system before propagating SchedulePaint up the view hierarchy.
502 // TODO(beng): Make protected.
503 virtual void SchedulePaint();
504 virtual void SchedulePaintInRect(const gfx::Rect& r);
506 // Called by the framework to paint a View. Performs translation and clipping
507 // for View coordinates and language direction as required, allows the View
508 // to paint itself via the various OnPaint*() event handlers and then paints
509 // the hierarchy beneath it.
510 virtual void Paint(gfx::Canvas* canvas);
512 // The background object is owned by this object and may be NULL.
513 void set_background(Background* b) { background_.reset(b); }
514 const Background* background() const { return background_.get(); }
515 Background* background() { return background_.get(); }
517 // The border object is owned by this object and may be NULL.
518 void set_border(Border* b) { border_.reset(b); }
519 const Border* border() const { return border_.get(); }
520 Border* border() { return border_.get(); }
522 // The focus_border object is owned by this object and may be NULL.
523 void set_focus_border(FocusBorder* b) { focus_border_.reset(b); }
524 const FocusBorder* focus_border() const { return focus_border_.get(); }
525 FocusBorder* focus_border() { return focus_border_.get(); }
527 // Get the theme provider from the parent widget.
528 virtual ui::ThemeProvider* GetThemeProvider() const;
530 // Returns the NativeTheme to use for this View. This calls through to
531 // GetNativeTheme() on the Widget this View is in. If this View is not in a
532 // Widget this returns ui::NativeTheme::instance().
533 ui::NativeTheme* GetNativeTheme() {
534 return const_cast<ui::NativeTheme*>(
535 const_cast<const View*>(this)->GetNativeTheme());
537 const ui::NativeTheme* GetNativeTheme() const;
539 // RTL painting --------------------------------------------------------------
541 // This method determines whether the gfx::Canvas object passed to
542 // View::Paint() needs to be transformed such that anything drawn on the
543 // canvas object during View::Paint() is flipped horizontally.
545 // By default, this function returns false (which is the initial value of
546 // |flip_canvas_on_paint_for_rtl_ui_|). View subclasses that need to paint on
547 // a flipped gfx::Canvas when the UI layout is right-to-left need to call
548 // EnableCanvasFlippingForRTLUI().
549 bool FlipCanvasOnPaintForRTLUI() const {
550 return flip_canvas_on_paint_for_rtl_ui_ ? base::i18n::IsRTL() : false;
553 // Enables or disables flipping of the gfx::Canvas during View::Paint().
554 // Note that if canvas flipping is enabled, the canvas will be flipped only
555 // if the UI layout is right-to-left; that is, the canvas will be flipped
556 // only if base::i18n::IsRTL() returns true.
558 // Enabling canvas flipping is useful for leaf views that draw an image that
559 // needs to be flipped horizontally when the UI layout is right-to-left
560 // (views::Button, for example). This method is helpful for such classes
561 // because their drawing logic stays the same and they can become agnostic to
562 // the UI directionality.
563 void EnableCanvasFlippingForRTLUI(bool enable) {
564 flip_canvas_on_paint_for_rtl_ui_ = enable;
567 // Accelerated painting ------------------------------------------------------
569 // Enable/Disable accelerated compositing.
570 static void set_use_acceleration_when_possible(bool use);
571 static bool get_use_acceleration_when_possible();
573 // Input ---------------------------------------------------------------------
574 // The points (and mouse locations) in the following functions are in the
575 // view's coordinates, except for a RootView.
577 // Returns the deepest visible descendant that contains the specified point
578 // and supports event handling.
579 virtual View* GetEventHandlerForPoint(const gfx::Point& point);
581 // Returns the deepest visible descendant that contains the specified point
582 // and supports tooltips. If the view does not contain the point, returns
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 // A convenience function which calls HitTestRect() with a rect of size
594 // 1x1 and an origin of |point|.
595 bool HitTestPoint(const gfx::Point& point) const;
597 // Tests whether |rect| intersects this view's bounds.
598 virtual bool HitTestRect(const gfx::Rect& rect) const;
600 // Returns true if the mouse cursor is over |view| and mouse events are
602 bool IsMouseHovered();
604 // This method is invoked when the user clicks on this view.
605 // The provided event is in the receiver's coordinate system.
607 // Return true if you processed the event and want to receive subsequent
608 // MouseDraggged and MouseReleased events. This also stops the event from
609 // bubbling. If you return false, the event will bubble through parent
612 // If you remove yourself from the tree while processing this, event bubbling
613 // stops as if you returned true, but you will not receive future events.
614 // The return value is ignored in this case.
616 // Default implementation returns true if a ContextMenuController has been
617 // set, false otherwise. Override as needed.
619 virtual bool OnMousePressed(const ui::MouseEvent& event);
621 // This method is invoked when the user clicked on this control.
622 // and is still moving the mouse with a button pressed.
623 // The provided event is in the receiver's coordinate system.
625 // Return true if you processed the event and want to receive
626 // subsequent MouseDragged and MouseReleased events.
628 // Default implementation returns true if a ContextMenuController has been
629 // set, false otherwise. Override as needed.
631 virtual bool OnMouseDragged(const ui::MouseEvent& event);
633 // This method is invoked when the user releases the mouse
634 // button. The event is in the receiver's coordinate system.
636 // Default implementation notifies the ContextMenuController is appropriate.
637 // Subclasses that wish to honor the ContextMenuController should invoke
639 virtual void OnMouseReleased(const ui::MouseEvent& event);
641 // This method is invoked when the mouse press/drag was canceled by a
642 // system/user gesture.
643 virtual void OnMouseCaptureLost();
645 // This method is invoked when the mouse is above this control
646 // The event is in the receiver's coordinate system.
648 // Default implementation does nothing. Override as needed.
649 virtual void OnMouseMoved(const ui::MouseEvent& event);
651 // This method is invoked when the mouse enters this control.
653 // Default implementation does nothing. Override as needed.
654 virtual void OnMouseEntered(const ui::MouseEvent& event);
656 // This method is invoked when the mouse exits this control
657 // The provided event location is always (0, 0)
658 // Default implementation does nothing. Override as needed.
659 virtual void OnMouseExited(const ui::MouseEvent& event);
661 // Set the MouseHandler for a drag session.
663 // A drag session is a stream of mouse events starting
664 // with a MousePressed event, followed by several MouseDragged
665 // events and finishing with a MouseReleased event.
667 // This method should be only invoked while processing a
668 // MouseDragged or MousePressed event.
670 // All further mouse dragged and mouse up events will be sent
671 // the MouseHandler, even if it is reparented to another window.
673 // The MouseHandler is automatically cleared when the control
674 // comes back from processing the MouseReleased event.
676 // Note: if the mouse handler is no longer connected to a
677 // view hierarchy, events won't be sent.
679 // TODO(sky): rename this.
680 virtual void SetMouseHandler(View* new_mouse_handler);
682 // Invoked when a key is pressed or released.
683 // Subclasser should return true if the event has been processed and false
684 // otherwise. If the event has not been processed, the parent will be given a
686 virtual bool OnKeyPressed(const ui::KeyEvent& event);
687 virtual bool OnKeyReleased(const ui::KeyEvent& event);
689 // Invoked when the user uses the mousewheel. Implementors should return true
690 // if the event has been processed and false otherwise. This message is sent
691 // if the view is focused. If the event has not been processed, the parent
692 // will be given a chance.
693 virtual bool OnMouseWheel(const ui::MouseWheelEvent& event);
696 // See field for description.
697 void set_notify_enter_exit_on_child(bool notify) {
698 notify_enter_exit_on_child_ = notify;
700 bool notify_enter_exit_on_child() const {
701 return notify_enter_exit_on_child_;
704 // Returns the View's TextInputClient instance or NULL if the View doesn't
705 // support text input.
706 virtual ui::TextInputClient* GetTextInputClient();
708 // Convenience method to retrieve the InputMethod associated with the
709 // Widget that contains this view. Returns NULL if this view is not part of a
710 // view hierarchy with a Widget.
711 virtual InputMethod* GetInputMethod();
712 virtual const InputMethod* GetInputMethod() const;
714 // Overridden from ui::EventTarget:
715 virtual bool CanAcceptEvent(const ui::Event& event) OVERRIDE;
716 virtual ui::EventTarget* GetParentTarget() OVERRIDE;
718 // Overridden from ui::EventHandler:
719 virtual void OnKeyEvent(ui::KeyEvent* event) OVERRIDE;
720 virtual void OnMouseEvent(ui::MouseEvent* event) OVERRIDE;
721 virtual void OnScrollEvent(ui::ScrollEvent* event) OVERRIDE;
722 virtual void OnTouchEvent(ui::TouchEvent* event) OVERRIDE;
723 virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE;
725 // Accelerators --------------------------------------------------------------
727 // Sets a keyboard accelerator for that view. When the user presses the
728 // accelerator key combination, the AcceleratorPressed method is invoked.
729 // Note that you can set multiple accelerators for a view by invoking this
730 // method several times. Note also that AcceleratorPressed is invoked only
731 // when CanHandleAccelerators() is true.
732 virtual void AddAccelerator(const ui::Accelerator& accelerator);
734 // Removes the specified accelerator for this view.
735 virtual void RemoveAccelerator(const ui::Accelerator& accelerator);
737 // Removes all the keyboard accelerators for this view.
738 virtual void ResetAccelerators();
740 // Overridden from AcceleratorTarget:
741 virtual bool AcceleratorPressed(const ui::Accelerator& accelerator) OVERRIDE;
743 // Returns whether accelerators are enabled for this view. Accelerators are
744 // enabled if the containing widget is visible and the view is enabled() and
746 virtual bool CanHandleAccelerators() const OVERRIDE;
748 // Focus ---------------------------------------------------------------------
750 // Returns whether this view currently has the focus.
751 virtual bool HasFocus() const;
753 // Returns the view that should be selected next when pressing Tab.
754 View* GetNextFocusableView();
755 const View* GetNextFocusableView() const;
757 // Returns the view that should be selected next when pressing Shift-Tab.
758 View* GetPreviousFocusableView();
760 // Sets the component that should be selected next when pressing Tab, and
761 // makes the current view the precedent view of the specified one.
762 // Note that by default views are linked in the order they have been added to
763 // their container. Use this method if you want to modify the order.
764 // IMPORTANT NOTE: loops in the focus hierarchy are not supported.
765 void SetNextFocusableView(View* view);
767 // Sets whether this view is capable of taking focus.
768 // Note that this is false by default so that a view used as a container does
769 // not get the focus.
770 void set_focusable(bool focusable) { focusable_ = focusable; }
772 // Returns true if this view is capable of taking focus.
773 bool focusable() const { return focusable_ && enabled_ && visible_; }
775 // Returns true if this view is |focusable_|, |enabled_| and drawn.
776 virtual bool IsFocusable() const;
778 // Return whether this view is focusable when the user requires full keyboard
779 // access, even though it may not be normally focusable.
780 bool IsAccessibilityFocusable() const;
782 // Set whether this view can be made focusable if the user requires
783 // full keyboard access, even though it's not normally focusable.
784 // Note that this is false by default.
785 void set_accessibility_focusable(bool accessibility_focusable) {
786 accessibility_focusable_ = accessibility_focusable;
789 // Convenience method to retrieve the FocusManager associated with the
790 // Widget that contains this view. This can return NULL if this view is not
791 // part of a view hierarchy with a Widget.
792 virtual FocusManager* GetFocusManager();
793 virtual const FocusManager* GetFocusManager() const;
795 // Request keyboard focus. The receiving view will become the focused view.
796 virtual void RequestFocus();
798 // Invoked when a view is about to be requested for focus due to the focus
799 // traversal. Reverse is this request was generated going backward
801 virtual void AboutToRequestFocusFromTabTraversal(bool reverse) {}
803 // Invoked when a key is pressed before the key event is processed (and
804 // potentially eaten) by the focus manager for tab traversal, accelerators and
805 // other focus related actions.
806 // The default implementation returns false, ensuring that tab traversal and
807 // accelerators processing is performed.
808 // Subclasses should return true if they want to process the key event and not
809 // have it processed as an accelerator (if any) or as a tab traversal (if the
810 // key event is for the TAB key). In that case, OnKeyPressed will
811 // subsequently be invoked for that event.
812 virtual bool SkipDefaultKeyEventProcessing(const ui::KeyEvent& event);
814 // Subclasses that contain traversable children that are not directly
815 // accessible through the children hierarchy should return the associated
816 // FocusTraversable for the focus traversal to work properly.
817 virtual FocusTraversable* GetFocusTraversable();
819 // Subclasses that can act as a "pane" must implement their own
820 // FocusTraversable to keep the focus trapped within the pane.
821 // If this method returns an object, any view that's a direct or
822 // indirect child of this view will always use this FocusTraversable
823 // rather than the one from the widget.
824 virtual FocusTraversable* GetPaneFocusTraversable();
826 // Tooltips ------------------------------------------------------------------
828 // Gets the tooltip for this View. If the View does not have a tooltip,
829 // return false. If the View does have a tooltip, copy the tooltip into
830 // the supplied string and return true.
831 // Any time the tooltip text that a View is displaying changes, it must
832 // invoke TooltipTextChanged.
833 // |p| provides the coordinates of the mouse (relative to this view).
834 virtual bool GetTooltipText(const gfx::Point& p, string16* tooltip) const;
836 // Returns the location (relative to this View) for the text on the tooltip
837 // to display. If false is returned (the default), the tooltip is placed at
838 // a default position.
839 virtual bool GetTooltipTextOrigin(const gfx::Point& p, gfx::Point* loc) const;
841 // Context menus -------------------------------------------------------------
843 // Sets the ContextMenuController. Setting this to non-null makes the View
844 // process mouse events.
845 ContextMenuController* context_menu_controller() {
846 return context_menu_controller_;
848 void set_context_menu_controller(ContextMenuController* menu_controller) {
849 context_menu_controller_ = menu_controller;
852 // Provides default implementation for context menu handling. The default
853 // implementation calls the ShowContextMenu of the current
854 // ContextMenuController (if it is not NULL). Overridden in subclassed views
855 // to provide right-click menu display triggerd by the keyboard (i.e. for the
856 // Chrome toolbar Back and Forward buttons). No source needs to be specified,
857 // as it is always equal to the current View.
858 virtual void ShowContextMenu(const gfx::Point& p,
859 ui::MenuSourceType source_type);
861 // On some platforms, we show context menu on mouse press instead of release.
862 // This method returns true for those platforms.
863 static bool ShouldShowContextMenuOnMousePress();
865 // Drag and drop -------------------------------------------------------------
867 DragController* drag_controller() { return drag_controller_; }
868 void set_drag_controller(DragController* drag_controller) {
869 drag_controller_ = drag_controller;
872 // During a drag and drop session when the mouse moves the view under the
873 // mouse is queried for the drop types it supports by way of the
874 // GetDropFormats methods. If the view returns true and the drag site can
875 // provide data in one of the formats, the view is asked if the drop data
876 // is required before any other drop events are sent. Once the
877 // data is available the view is asked if it supports the drop (by way of
878 // the CanDrop method). If a view returns true from CanDrop,
879 // OnDragEntered is sent to the view when the mouse first enters the view,
880 // as the mouse moves around within the view OnDragUpdated is invoked.
881 // If the user releases the mouse over the view and OnDragUpdated returns a
882 // valid drop, then OnPerformDrop is invoked. If the mouse moves outside the
883 // view or over another view that wants the drag, OnDragExited is invoked.
885 // Similar to mouse events, the deepest view under the mouse is first checked
886 // if it supports the drop (Drop). If the deepest view under
887 // the mouse does not support the drop, the ancestors are walked until one
888 // is found that supports the drop.
890 // Override and return the set of formats that can be dropped on this view.
891 // |formats| is a bitmask of the formats defined bye OSExchangeData::Format.
892 // The default implementation returns false, which means the view doesn't
894 virtual bool GetDropFormats(
896 std::set<OSExchangeData::CustomFormat>* custom_formats);
898 // Override and return true if the data must be available before any drop
899 // methods should be invoked. The default is false.
900 virtual bool AreDropTypesRequired();
902 // A view that supports drag and drop must override this and return true if
903 // data contains a type that may be dropped on this view.
904 virtual bool CanDrop(const OSExchangeData& data);
906 // OnDragEntered is invoked when the mouse enters this view during a drag and
907 // drop session and CanDrop returns true. This is immediately
908 // followed by an invocation of OnDragUpdated, and eventually one of
909 // OnDragExited or OnPerformDrop.
910 virtual void OnDragEntered(const ui::DropTargetEvent& event);
912 // Invoked during a drag and drop session while the mouse is over the view.
913 // This should return a bitmask of the DragDropTypes::DragOperation supported
914 // based on the location of the event. Return 0 to indicate the drop should
916 virtual int OnDragUpdated(const ui::DropTargetEvent& event);
918 // Invoked during a drag and drop session when the mouse exits the views, or
919 // when the drag session was canceled and the mouse was over the view.
920 virtual void OnDragExited();
922 // Invoked during a drag and drop session when OnDragUpdated returns a valid
923 // operation and the user release the mouse.
924 virtual int OnPerformDrop(const ui::DropTargetEvent& event);
926 // Invoked from DoDrag after the drag completes. This implementation does
927 // nothing, and is intended for subclasses to do cleanup.
928 virtual void OnDragDone();
930 // Returns true if the mouse was dragged enough to start a drag operation.
931 // delta_x and y are the distance the mouse was dragged.
932 static bool ExceededDragThreshold(const gfx::Vector2d& delta);
934 // Accessibility -------------------------------------------------------------
936 // Modifies |state| to reflect the current accessible state of this view.
937 virtual void GetAccessibleState(ui::AccessibleViewState* state) { }
939 // Returns an instance of the native accessibility interface for this view.
940 virtual gfx::NativeViewAccessible GetNativeViewAccessible();
942 // Notifies assistive technology that an accessibility event has
943 // occurred on this view, such as when the view is focused or when its
944 // value changes. Pass true for |send_native_event| except for rare
945 // cases where the view is a native control that's already sending a
946 // native accessibility event and the duplicate event would cause
948 void NotifyAccessibilityEvent(ui::AccessibilityTypes::Event event_type,
949 bool send_native_event);
951 // Scrolling -----------------------------------------------------------------
952 // TODO(beng): Figure out if this can live somewhere other than View, i.e.
953 // closer to ScrollView.
955 // Scrolls the specified region, in this View's coordinate system, to be
956 // visible. View's implementation passes the call onto the parent View (after
957 // adjusting the coordinates). It is up to views that only show a portion of
958 // the child view, such as Viewport, to override appropriately.
959 virtual void ScrollRectToVisible(const gfx::Rect& rect);
961 // The following methods are used by ScrollView to determine the amount
962 // to scroll relative to the visible bounds of the view. For example, a
963 // return value of 10 indicates the scrollview should scroll 10 pixels in
964 // the appropriate direction.
966 // Each method takes the following parameters:
968 // is_horizontal: if true, scrolling is along the horizontal axis, otherwise
969 // the vertical axis.
970 // is_positive: if true, scrolling is by a positive amount. Along the
971 // vertical axis scrolling by a positive amount equates to
974 // The return value should always be positive and gives the number of pixels
975 // to scroll. ScrollView interprets a return value of 0 (or negative)
976 // to scroll by a default amount.
978 // See VariableRowHeightScrollHelper and FixedRowHeightScrollHelper for
979 // implementations of common cases.
980 virtual int GetPageScrollIncrement(ScrollView* scroll_view,
981 bool is_horizontal, bool is_positive);
982 virtual int GetLineScrollIncrement(ScrollView* scroll_view,
983 bool is_horizontal, bool is_positive);
986 // Used to track a drag. RootView passes this into
987 // ProcessMousePressed/Dragged.
989 // Sets possible_drag to false and start_x/y to 0. This is invoked by
990 // RootView prior to invoke ProcessMousePressed.
993 // Sets possible_drag to true and start_pt to the specified point.
994 // This is invoked by the target view if it detects the press may generate
996 void PossibleDrag(const gfx::Point& p);
998 // Whether the press may generate a drag.
1001 // Coordinates of the mouse press.
1002 gfx::Point start_pt;
1005 // Size and disposition ------------------------------------------------------
1007 // Override to be notified when the bounds of the view have changed.
1008 virtual void OnBoundsChanged(const gfx::Rect& previous_bounds);
1010 // Called when the preferred size of a child view changed. This gives the
1011 // parent an opportunity to do a fresh layout if that makes sense.
1012 virtual void ChildPreferredSizeChanged(View* child) {}
1014 // Called when the visibility of a child view changed. This gives the parent
1015 // an opportunity to do a fresh layout if that makes sense.
1016 virtual void ChildVisibilityChanged(View* child) {}
1018 // Invalidates the layout and calls ChildPreferredSizeChanged on the parent
1019 // if there is one. Be sure to call View::PreferredSizeChanged when
1020 // overriding such that the layout is properly invalidated.
1021 virtual void PreferredSizeChanged();
1023 // Override returning true when the view needs to be notified when its visible
1024 // bounds relative to the root view may have changed. Only used by
1026 virtual bool NeedsNotificationWhenVisibleBoundsChange() const;
1028 // Notification that this View's visible bounds relative to the root view may
1029 // have changed. The visible bounds are the region of the View not clipped by
1030 // its ancestors. This is used for clipping NativeViewHost.
1031 virtual void OnVisibleBoundsChanged();
1033 // Override to be notified when the enabled state of this View has
1034 // changed. The default implementation calls SchedulePaint() on this View.
1035 virtual void OnEnabledChanged();
1037 // Tree operations -----------------------------------------------------------
1039 // This method is invoked when the tree changes.
1041 // When a view is removed, it is invoked for all children and grand
1042 // children. For each of these views, a notification is sent to the
1043 // view and all parents.
1045 // When a view is added, a notification is sent to the view, all its
1046 // parents, and all its children (and grand children)
1048 // Default implementation does nothing. Override to perform operations
1049 // required when a view is added or removed from a view hierarchy
1051 // Refer to comments in struct |ViewHierarchyChangedDetails| for |details|.
1052 virtual void ViewHierarchyChanged(const ViewHierarchyChangedDetails& details);
1054 // When SetVisible() changes the visibility of a view, this method is
1055 // invoked for that view as well as all the children recursively.
1056 virtual void VisibilityChanged(View* starting_from, bool is_visible);
1058 // This method is invoked when the parent NativeView of the widget that the
1059 // view is attached to has changed and the view hierarchy has not changed.
1060 // ViewHierarchyChanged() is called when the parent NativeView of the widget
1061 // that the view is attached to is changed as a result of changing the view
1062 // hierarchy. Overriding this method is useful for tracking which
1063 // FocusManager manages this view.
1064 virtual void NativeViewHierarchyChanged();
1066 // Painting ------------------------------------------------------------------
1068 // Responsible for calling Paint() on child Views. Override to control the
1069 // order child Views are painted.
1070 virtual void PaintChildren(gfx::Canvas* canvas);
1072 // Override to provide rendering in any part of the View's bounds. Typically
1073 // this is the "contents" of the view. If you override this method you will
1074 // have to call the subsequent OnPaint*() methods manually.
1075 virtual void OnPaint(gfx::Canvas* canvas);
1077 // Override to paint a background before any content is drawn. Typically this
1078 // is done if you are satisfied with a default OnPaint handler but wish to
1079 // supply a different background.
1080 virtual void OnPaintBackground(gfx::Canvas* canvas);
1082 // Override to paint a border not specified by SetBorder().
1083 virtual void OnPaintBorder(gfx::Canvas* canvas);
1085 // Override to paint a focus border not specified by set_focus_border() around
1086 // relevant contents. The focus border is usually a dotted rectangle.
1087 virtual void OnPaintFocusBorder(gfx::Canvas* canvas);
1089 // Accelerated painting ------------------------------------------------------
1091 // Returns the offset from this view to the nearest ancestor with a layer. If
1092 // |layer_parent| is non-NULL it is set to the nearest ancestor with a layer.
1093 virtual gfx::Vector2d CalculateOffsetToAncestorWithLayer(
1094 ui::Layer** layer_parent);
1096 // Updates the view's layer's parent. Called when a view is added to a view
1097 // hierarchy, responsible for parenting the view's layer to the enclosing
1098 // layer in the hierarchy.
1099 virtual void UpdateParentLayer();
1101 // If this view has a layer, the layer is reparented to |parent_layer| and its
1102 // bounds is set based on |point|. If this view does not have a layer, then
1103 // recurses through all children. This is used when adding a layer to an
1104 // existing view to make sure all descendants that have layers are parented to
1106 virtual void MoveLayerToParent(ui::Layer* parent_layer,
1107 const gfx::Point& point);
1109 // Called to update the bounds of any child layers within this View's
1110 // hierarchy when something happens to the hierarchy.
1111 virtual void UpdateChildLayerBounds(const gfx::Vector2d& offset);
1113 // Overridden from ui::LayerDelegate:
1114 virtual void OnPaintLayer(gfx::Canvas* canvas) OVERRIDE;
1115 virtual void OnDeviceScaleFactorChanged(float device_scale_factor) OVERRIDE;
1116 virtual base::Closure PrepareForLayerBoundsChange() OVERRIDE;
1118 // Finds the layer that this view paints to (it may belong to an ancestor
1119 // view), then reorders the immediate children of that layer to match the
1120 // order of the view tree.
1121 virtual void ReorderLayers();
1123 // This reorders the immediate children of |*parent_layer| to match the
1124 // order of the view tree. Child layers which are owned by a view are
1125 // reordered so that they are below any child layers not owned by a view.
1126 // Widget::ReorderNativeViews() should be called to reorder any child layers
1127 // with an associated view. Widget::ReorderNativeViews() may reorder layers
1128 // below layers owned by a view.
1129 virtual void ReorderChildLayers(ui::Layer* parent_layer);
1131 // Input ---------------------------------------------------------------------
1133 // Called by HitTestRect() to see if this View has a custom hit test mask. If
1134 // the return value is true, GetHitTestMask() will be called to obtain the
1135 // mask. Default value is false, in which case the View will hit-test against
1137 virtual bool HasHitTestMask() const;
1139 // Called by HitTestRect() to retrieve a mask for hit-testing against.
1140 // Subclasses override to provide custom shaped hit test regions.
1141 virtual void GetHitTestMask(HitTestSource source, gfx::Path* mask) const;
1143 virtual DragInfo* GetDragInfo();
1145 // Focus ---------------------------------------------------------------------
1147 // Override to be notified when focus has changed either to or from this View.
1148 virtual void OnFocus();
1149 virtual void OnBlur();
1151 // Handle view focus/blur events for this view.
1155 // System events -------------------------------------------------------------
1157 // Called when the UI theme (not the NativeTheme) has changed, overriding
1158 // allows individual Views to do special cleanup and processing (such as
1159 // dropping resource caches). To dispatch a theme changed notification, call
1160 // Widget::ThemeChanged().
1161 virtual void OnThemeChanged() {}
1163 // Called when the locale has changed, overriding allows individual Views to
1164 // update locale-dependent strings.
1165 // To dispatch a locale changed notification, call Widget::LocaleChanged().
1166 virtual void OnLocaleChanged() {}
1168 // Tooltips ------------------------------------------------------------------
1170 // Views must invoke this when the tooltip text they are to display changes.
1171 void TooltipTextChanged();
1173 // Context menus -------------------------------------------------------------
1175 // Returns the location, in screen coordinates, to show the context menu at
1176 // when the context menu is shown from the keyboard. This implementation
1177 // returns the middle of the visible region of this view.
1179 // This method is invoked when the context menu is shown by way of the
1181 virtual gfx::Point GetKeyboardContextMenuLocation();
1183 // Drag and drop -------------------------------------------------------------
1185 // These are cover methods that invoke the method of the same name on
1186 // the DragController. Subclasses may wish to override rather than install
1187 // a DragController.
1188 // See DragController for a description of these methods.
1189 virtual int GetDragOperations(const gfx::Point& press_pt);
1190 virtual void WriteDragData(const gfx::Point& press_pt, OSExchangeData* data);
1192 // Returns whether we're in the middle of a drag session that was initiated
1196 // Returns how much the mouse needs to move in one direction to start a
1197 // drag. These methods cache in a platform-appropriate way. These values are
1198 // used by the public static method ExceededDragThreshold().
1199 static int GetHorizontalDragThreshold();
1200 static int GetVerticalDragThreshold();
1202 // NativeTheme ---------------------------------------------------------------
1204 // Invoked when the NativeTheme associated with this View changes.
1205 virtual void OnNativeThemeChanged(const ui::NativeTheme* theme) {}
1207 // Debugging -----------------------------------------------------------------
1209 #if !defined(NDEBUG)
1210 // Returns string containing a graph of the views hierarchy in graphViz DOT
1211 // language (http://graphviz.org/). Can be called within debugger and save
1212 // to a file to compile/view.
1213 // Note: Assumes initial call made with first = true.
1214 virtual std::string PrintViewGraph(bool first);
1216 // Some classes may own an object which contains the children to displayed in
1217 // the views hierarchy. The above function gives the class the flexibility to
1218 // decide which object should be used to obtain the children, but this
1219 // function makes the decision explicit.
1220 std::string DoPrintViewGraph(bool first, View* view_with_children);
1224 friend class internal::PostEventDispatchHandler;
1225 friend class internal::RootView;
1226 friend class FocusManager;
1227 friend class Widget;
1229 // Painting -----------------------------------------------------------------
1231 enum SchedulePaintType {
1232 // Indicates the size is the same (only the origin changed).
1233 SCHEDULE_PAINT_SIZE_SAME,
1235 // Indicates the size changed (and possibly the origin).
1236 SCHEDULE_PAINT_SIZE_CHANGED
1239 // Invoked before and after the bounds change to schedule painting the old and
1241 void SchedulePaintBoundsChanged(SchedulePaintType type);
1243 // Common Paint() code shared by accelerated and non-accelerated code paths to
1244 // invoke OnPaint() on the View.
1245 void PaintCommon(gfx::Canvas* canvas);
1247 // Tree operations -----------------------------------------------------------
1249 // Removes |view| from the hierarchy tree. If |update_focus_cycle| is true,
1250 // the next and previous focusable views of views pointing to this view are
1251 // updated. If |update_tool_tip| is true, the tooltip is updated. If
1252 // |delete_removed_view| is true, the view is also deleted (if it is parent
1253 // owned). If |new_parent| is not NULL, the remove is the result of
1254 // AddChildView() to a new parent. For this case, |new_parent| is the View
1255 // that |view| is going to be added to after the remove completes.
1256 void DoRemoveChildView(View* view,
1257 bool update_focus_cycle,
1258 bool update_tool_tip,
1259 bool delete_removed_view,
1262 // Call ViewHierarchyChanged() for all child views and all parents.
1263 // |old_parent| is the original parent of the View that was removed.
1264 // If |new_parent| is not NULL, the View that was removed will be reparented
1265 // to |new_parent| after the remove operation.
1266 void PropagateRemoveNotifications(View* old_parent, View* new_parent);
1268 // Call ViewHierarchyChanged() for all children.
1269 void PropagateAddNotifications(const ViewHierarchyChangedDetails& details);
1271 // Propagates NativeViewHierarchyChanged() notification through all the
1273 void PropagateNativeViewHierarchyChanged();
1275 // Takes care of registering/unregistering accelerators if
1276 // |register_accelerators| true and calls ViewHierarchyChanged().
1277 void ViewHierarchyChangedImpl(bool register_accelerators,
1278 const ViewHierarchyChangedDetails& details);
1280 // Invokes OnNativeThemeChanged() on this and all descendants.
1281 void PropagateNativeThemeChanged(const ui::NativeTheme* theme);
1283 // Size and disposition ------------------------------------------------------
1285 // Call VisibilityChanged() recursively for all children.
1286 void PropagateVisibilityNotifications(View* from, bool is_visible);
1288 // Registers/unregisters accelerators as necessary and calls
1289 // VisibilityChanged().
1290 void VisibilityChangedImpl(View* starting_from, bool is_visible);
1292 // Responsible for propagating bounds change notifications to relevant
1294 void BoundsChanged(const gfx::Rect& previous_bounds);
1296 // Visible bounds notification registration.
1297 // When a view is added to a hierarchy, it and all its children are asked if
1298 // they need to be registered for "visible bounds within root" notifications
1299 // (see comment on OnVisibleBoundsChanged()). If they do, they are registered
1300 // with every ancestor between them and the root of the hierarchy.
1301 static void RegisterChildrenForVisibleBoundsNotification(View* view);
1302 static void UnregisterChildrenForVisibleBoundsNotification(View* view);
1303 void RegisterForVisibleBoundsNotification();
1304 void UnregisterForVisibleBoundsNotification();
1306 // Adds/removes view to the list of descendants that are notified any time
1307 // this views location and possibly size are changed.
1308 void AddDescendantToNotify(View* view);
1309 void RemoveDescendantToNotify(View* view);
1311 // Sets the layer's bounds given in DIP coordinates.
1312 void SetLayerBounds(const gfx::Rect& bounds_in_dip);
1314 // Transformations -----------------------------------------------------------
1316 // Returns in |transform| the transform to get from coordinates of |ancestor|
1317 // to this. Returns true if |ancestor| is found. If |ancestor| is not found,
1318 // or NULL, |transform| is set to convert from root view coordinates to this.
1319 bool GetTransformRelativeTo(const View* ancestor,
1320 gfx::Transform* transform) const;
1322 // Coordinate conversion -----------------------------------------------------
1324 // Convert a point in the view's coordinate to an ancestor view's coordinate
1325 // system using necessary transformations. Returns whether the point was
1326 // successfully converted to the ancestor's coordinate system.
1327 bool ConvertPointForAncestor(const View* ancestor, gfx::Point* point) const;
1329 // Convert a point in the ancestor's coordinate system to the view's
1330 // coordinate system using necessary transformations. Returns whether the
1331 // point was successfully converted from the ancestor's coordinate system
1332 // to the view's coordinate system.
1333 bool ConvertPointFromAncestor(const View* ancestor, gfx::Point* point) const;
1335 // Convert a rect in the view's coordinate to an ancestor view's coordinate
1336 // system using necessary transformations. Returns whether the rect was
1337 // successfully converted to the ancestor's coordinate system.
1338 bool ConvertRectForAncestor(const View* ancestor, gfx::RectF* rect) const;
1340 // Convert a rect in the ancestor's coordinate system to the view's
1341 // coordinate system using necessary transformations. Returns whether the
1342 // rect was successfully converted from the ancestor's coordinate system
1343 // to the view's coordinate system.
1344 bool ConvertRectFromAncestor(const View* ancestor, gfx::RectF* rect) const;
1346 // Accelerated painting ------------------------------------------------------
1348 // Creates the layer and related fields for this view.
1351 // Parents all un-parented layers within this view's hierarchy to this view's
1353 void UpdateParentLayers();
1355 // Parents this view's layer to |parent_layer|, and sets its bounds and other
1356 // properties in accordance to |offset|, the view's offset from the
1358 void ReparentLayer(const gfx::Vector2d& offset, ui::Layer* parent_layer);
1360 // Called to update the layer visibility. The layer will be visible if the
1361 // View itself, and all its parent Views are visible. This also updates
1362 // visibility of the child layers.
1363 void UpdateLayerVisibility();
1364 void UpdateChildLayerVisibility(bool visible);
1366 // Orphans the layers in this subtree that are parented to layers outside of
1368 void OrphanLayers();
1370 // Destroys the layer associated with this view, and reparents any descendants
1371 // to the destroyed layer's parent.
1372 void DestroyLayer();
1374 // Input ---------------------------------------------------------------------
1376 bool ProcessMousePressed(const ui::MouseEvent& event);
1377 bool ProcessMouseDragged(const ui::MouseEvent& event);
1378 void ProcessMouseReleased(const ui::MouseEvent& event);
1380 // Accelerators --------------------------------------------------------------
1382 // Registers this view's keyboard accelerators that are not registered to
1383 // FocusManager yet, if possible.
1384 void RegisterPendingAccelerators();
1386 // Unregisters all the keyboard accelerators associated with this view.
1387 // |leave_data_intact| if true does not remove data from accelerators_ array,
1388 // so it could be re-registered with other focus manager
1389 void UnregisterAccelerators(bool leave_data_intact);
1391 // Focus ---------------------------------------------------------------------
1393 // Initialize the previous/next focusable views of the specified view relative
1394 // to the view at the specified index.
1395 void InitFocusSiblings(View* view, int index);
1397 // System events -------------------------------------------------------------
1399 // Used to propagate theme changed notifications from the root view to all
1400 // views in the hierarchy.
1401 virtual void PropagateThemeChanged();
1403 // Used to propagate locale changed notifications from the root view to all
1404 // views in the hierarchy.
1405 virtual void PropagateLocaleChanged();
1407 // Tooltips ------------------------------------------------------------------
1409 // Propagates UpdateTooltip() to the TooltipManager for the Widget.
1410 // This must be invoked any time the View hierarchy changes in such a way
1411 // the view under the mouse differs. For example, if the bounds of a View is
1412 // changed, this is invoked. Similarly, as Views are added/removed, this
1414 void UpdateTooltip();
1416 // Drag and drop -------------------------------------------------------------
1418 // Starts a drag and drop operation originating from this view. This invokes
1419 // WriteDragData to write the data and GetDragOperations to determine the
1420 // supported drag operations. When done, OnDragDone is invoked. |press_pt| is
1421 // in the view's coordinate system.
1422 // Returns true if a drag was started.
1423 bool DoDrag(const ui::LocatedEvent& event,
1424 const gfx::Point& press_pt,
1425 ui::DragDropTypes::DragEventSource source);
1427 //////////////////////////////////////////////////////////////////////////////
1429 // Creation and lifetime -----------------------------------------------------
1431 // False if this View is owned by its parent - i.e. it will be deleted by its
1432 // parent during its parents destruction. False is the default.
1433 bool owned_by_client_;
1435 // Attributes ----------------------------------------------------------------
1437 // The id of this View. Used to find this View.
1440 // The group of this view. Some view subclasses use this id to find other
1441 // views of the same group. For example radio button uses this information
1442 // to find other radio buttons.
1445 // Tree operations -----------------------------------------------------------
1447 // This view's parent.
1450 // This view's children.
1453 // Size and disposition ------------------------------------------------------
1455 // This View's bounds in the parent coordinate system.
1458 // Whether this view is visible.
1461 // Whether this view is enabled.
1464 // When this flag is on, a View receives a mouse-enter and mouse-leave event
1465 // even if a descendant View is the event-recipient for the real mouse
1466 // events. When this flag is turned on, and mouse moves from outside of the
1467 // view into a child view, both the child view and this view receives
1468 // mouse-enter event. Similarly, if the mouse moves from inside a child view
1469 // and out of this view, then both views receive a mouse-leave event.
1470 // When this flag is turned off, if the mouse moves from inside this view into
1471 // a child view, then this view receives a mouse-leave event. When this flag
1472 // is turned on, it does not receive the mouse-leave event in this case.
1473 // When the mouse moves from inside the child view out of the child view but
1474 // still into this view, this view receives a mouse-enter event if this flag
1475 // is turned off, but doesn't if this flag is turned on.
1476 // This flag is initialized to false.
1477 bool notify_enter_exit_on_child_;
1479 // Whether or not RegisterViewForVisibleBoundsNotification on the RootView
1480 // has been invoked.
1481 bool registered_for_visible_bounds_notification_;
1483 // List of descendants wanting notification when their visible bounds change.
1484 scoped_ptr<Views> descendants_to_notify_;
1486 // Transformations -----------------------------------------------------------
1488 // Clipping parameters. skia transformation matrix does not give us clipping.
1489 // So we do it ourselves.
1490 gfx::Insets clip_insets_;
1492 // Layout --------------------------------------------------------------------
1494 // Whether the view needs to be laid out.
1497 // The View's LayoutManager defines the sizing heuristics applied to child
1498 // Views. The default is absolute positioning according to bounds_.
1499 scoped_ptr<LayoutManager> layout_manager_;
1501 // Painting ------------------------------------------------------------------
1504 scoped_ptr<Background> background_;
1507 scoped_ptr<Border> border_;
1510 scoped_ptr<FocusBorder> focus_border_;
1512 // RTL painting --------------------------------------------------------------
1514 // Indicates whether or not the gfx::Canvas object passed to View::Paint()
1515 // is going to be flipped horizontally (using the appropriate transform) on
1516 // right-to-left locales for this View.
1517 bool flip_canvas_on_paint_for_rtl_ui_;
1519 // Accelerated painting ------------------------------------------------------
1521 bool paint_to_layer_;
1523 // Accelerators --------------------------------------------------------------
1525 // Focus manager accelerators registered on.
1526 FocusManager* accelerator_focus_manager_;
1528 // The list of accelerators. List elements in the range
1529 // [0, registered_accelerator_count_) are already registered to FocusManager,
1530 // and the rest are not yet.
1531 scoped_ptr<std::vector<ui::Accelerator> > accelerators_;
1532 size_t registered_accelerator_count_;
1534 // Focus ---------------------------------------------------------------------
1536 // Next view to be focused when the Tab key is pressed.
1537 View* next_focusable_view_;
1539 // Next view to be focused when the Shift-Tab key combination is pressed.
1540 View* previous_focusable_view_;
1542 // Whether this view can be focused.
1545 // Whether this view is focusable if the user requires full keyboard access,
1546 // even though it may not be normally focusable.
1547 bool accessibility_focusable_;
1549 // Context menus -------------------------------------------------------------
1551 // The menu controller.
1552 ContextMenuController* context_menu_controller_;
1554 // Drag and drop -------------------------------------------------------------
1556 DragController* drag_controller_;
1558 // Input --------------------------------------------------------------------
1560 scoped_ptr<internal::PostEventDispatchHandler> post_dispatch_handler_;
1562 // Accessibility -------------------------------------------------------------
1564 // Belongs to this view, but it's reference-counted on some platforms
1565 // so we can't use a scoped_ptr. It's dereferenced in the destructor.
1566 NativeViewAccessibility* native_view_accessibility_;
1568 DISALLOW_COPY_AND_ASSIGN(View);
1571 } // namespace views
1573 #endif // UI_VIEWS_VIEW_H_