Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefView

CefBaseRefCounted
   |
   +--CefView

   in cef_view.h
Direct Known Subclasses:
CefBrowserView, CefButton, CefPanel, CefScrollView, CefTextfield

class CefView
extends CefBaseRefCounted

A View is a rectangle within the views View hierarchy. It is the base class for all Views. All size and position values are in density independent pixels (DIP) unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.


Method Summary
 virtual CefRefPtr< CefBrowserView > AsBrowserView()= 0
          Returns this View as a BrowserView or NULL if this is not a BrowserView.
 virtual CefRefPtr< CefButton > AsButton()= 0
          Returns this View as a Button or NULL if this is not a Button.
 virtual CefRefPtr< CefPanel > AsPanel()= 0
          Returns this View as a Panel or NULL if this is not a Panel.
 virtual CefRefPtr< CefScrollView > AsScrollView()= 0
          Returns this View as a ScrollView or NULL if this is not a ScrollView.
 virtual CefRefPtr< CefTextfield > AsTextfield()= 0
          Returns this View as a Textfield or NULL if this is not a Textfield.
 virtual bool ConvertPointFromScreen( CefPoint& point )= 0
          Convert |point| to this View's coordinate system from that of the screen.
 virtual bool ConvertPointFromView( CefRefPtr< CefView > view, CefPoint& point )= 0
          Convert |point| to this View's coordinate system from that |view|.
 virtual bool ConvertPointFromWindow( CefPoint& point )= 0
          Convert |point| to this View's coordinate system from that of the Window.
 virtual bool ConvertPointToScreen( CefPoint& point )= 0
          Convert |point| from this View's coordinate system to that of the screen.
 virtual bool ConvertPointToView( CefRefPtr< CefView > view, CefPoint& point )= 0
          Convert |point| from this View's coordinate system to that of |view|.
 virtual bool ConvertPointToWindow( CefPoint& point )= 0
          Convert |point| from this View's coordinate system to that of the Window.
 virtual cef_color_t GetBackgroundColor()= 0
          Returns the background color for this View.
 virtual CefRect GetBounds()= 0
          Returns the bounds (size and position) of this View.
 virtual CefRect GetBoundsInScreen()= 0
          Returns the bounds (size and position) of this View.
 virtual CefRefPtr< CefViewDelegate > GetDelegate()= 0
          Returns the delegate associated with this View, if any.
 virtual int GetGroupID()= 0
          Returns the group id of this View, or -1 if not set.
 virtual int GetHeightForWidth( int width )= 0
          Returns the height necessary to display this View with the provided width.
 virtual int GetID()= 0
          Returns the ID for this View.
 virtual CefSize GetMaximumSize()= 0
          Returns the maximum size for this View.
 virtual CefSize GetMinimumSize()= 0
          Returns the minimum size for this View.
 virtual CefRefPtr< CefView > GetParentView()= 0
          Returns the View that contains this View, if any.
 virtual CefPoint GetPosition()= 0
          Returns the position of this View.
 virtual CefSize GetPreferredSize()= 0
          Returns the size this View would like to be if enough space is available.
 virtual CefSize GetSize()= 0
          Returns the size of this View.
 virtual CefString GetTypeString()= 0
          Returns the type of this View as a string.
 virtual CefRefPtr< CefView > GetViewForID( int id )= 0
          Recursively descends the view tree starting at this View, and returns the first child that it encounters with the given ID.
 virtual CefRefPtr< CefWindow > GetWindow()= 0
          Returns the top-level Window hosting this View, if any.
 virtual void InvalidateLayout()= 0
          Indicate that this View and all parent Views require a re-layout.
 virtual bool IsAccessibilityFocusable()= 0
          Return whether this View is focusable when the user requires full keyboard access, even though it may not be normally focusable.
 virtual bool IsAttached()= 0
          Returns true if this View is currently attached to another View.
 virtual bool IsDrawn()= 0
          Returns whether this View is visible and drawn in a Window.
 virtual bool IsEnabled()= 0
          Returns whether this View is enabled.
 virtual bool IsFocusable()= 0
          Returns true if this View is focusable, enabled and drawn.
 virtual bool IsSame( CefRefPtr< CefView > that )= 0
          Returns true if this View is the same as |that| View.
 virtual bool IsValid()= 0
          Returns true if this View is valid.
 virtual bool IsVisible()= 0
          Returns whether this View is visible.
 virtual void RequestFocus()= 0
          Request keyboard focus.
 virtual void SetBackgroundColor( cef_color_t color )= 0
          Sets the background color for this View.
 virtual void SetBounds( const CefRect& bounds )= 0
          Sets the bounds (size and position) of this View.
 virtual void SetEnabled( bool enabled )= 0
          Set whether this View is enabled.
 virtual void SetFocusable( bool focusable )= 0
          Sets whether this View is capable of taking focus.
 virtual void SetGroupID( int group_id )= 0
          A group id is used to tag Views which are part of the same logical group.
 virtual void SetID( int id )= 0
          Sets the ID for this View.
 virtual void SetPosition( const CefPoint& position )= 0
          Sets the position of this View without changing the size.
 virtual void SetSize( const CefSize& size )= 0
          Sets the size of this View without changing the position.
 virtual void SetVisible( bool visible )= 0
          Sets whether this View is visible.
 virtual void SizeToPreferredSize()= 0
          Size this View to its preferred size.
 virtual CefString ToString( bool include_children )= 0
          Returns a string representation of this View which includes the type and various type-specific identifying attributes.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

AsBrowserView

public virtual CefRefPtr< CefBrowserView > AsBrowserView()= 0;
Returns this View as a BrowserView or NULL if this is not a BrowserView.

AsButton

public virtual CefRefPtr< CefButton > AsButton()= 0;
Returns this View as a Button or NULL if this is not a Button.

AsPanel

public virtual CefRefPtr< CefPanel > AsPanel()= 0;
Returns this View as a Panel or NULL if this is not a Panel.

AsScrollView

public virtual CefRefPtr< CefScrollView > AsScrollView()= 0;
Returns this View as a ScrollView or NULL if this is not a ScrollView.

AsTextfield

public virtual CefRefPtr< CefTextfield > AsTextfield()= 0;
Returns this View as a Textfield or NULL if this is not a Textfield.

ConvertPointFromScreen

public virtual bool ConvertPointFromScreen( CefPoint& point )= 0;
Convert |point| to this View's coordinate system from that of the screen. This View must belong to a Window when calling this method. Returns true if the conversion is successful or false otherwise. Use CefDisplay::ConvertPointFromPixels() before calling this method if conversion from display-specific pixel coordinates is necessary.

ConvertPointFromView

public virtual bool ConvertPointFromView( CefRefPtr< CefView > view, CefPoint& point )= 0;
Convert |point| to this View's coordinate system from that |view|. |view| needs to be in the same Window but not necessarily the same view hierarchy. Returns true if the conversion is successful or false otherwise.

ConvertPointFromWindow

public virtual bool ConvertPointFromWindow( CefPoint& point )= 0;
Convert |point| to this View's coordinate system from that of the Window. This View must belong to a Window when calling this method. Returns true if the conversion is successful or false otherwise.

ConvertPointToScreen

public virtual bool ConvertPointToScreen( CefPoint& point )= 0;
Convert |point| from this View's coordinate system to that of the screen. This View must belong to a Window when calling this method. Returns true if the conversion is successful or false otherwise. Use CefDisplay::ConvertPointToPixels() after calling this method if further conversion to display-specific pixel coordinates is desired.

ConvertPointToView

public virtual bool ConvertPointToView( CefRefPtr< CefView > view, CefPoint& point )= 0;
Convert |point| from this View's coordinate system to that of |view|. |view| needs to be in the same Window but not necessarily the same view hierarchy. Returns true if the conversion is successful or false otherwise.

ConvertPointToWindow

public virtual bool ConvertPointToWindow( CefPoint& point )= 0;
Convert |point| from this View's coordinate system to that of the Window. This View must belong to a Window when calling this method. Returns true if the conversion is successful or false otherwise.

GetBackgroundColor

public virtual cef_color_t GetBackgroundColor()= 0;
Returns the background color for this View.

GetBounds

public virtual CefRect GetBounds()= 0;
Returns the bounds (size and position) of this View. Position is in parent coordinates.

GetBoundsInScreen

public virtual CefRect GetBoundsInScreen()= 0;
Returns the bounds (size and position) of this View. Position is in screen coordinates.

GetDelegate

public virtual CefRefPtr< CefViewDelegate > GetDelegate()= 0;
Returns the delegate associated with this View, if any.

GetGroupID

public virtual int GetGroupID()= 0;
Returns the group id of this View, or -1 if not set.

GetHeightForWidth

public virtual int GetHeightForWidth( int width )= 0;
Returns the height necessary to display this View with the provided width.

GetID

public virtual int GetID()= 0;
Returns the ID for this View.

GetMaximumSize

public virtual CefSize GetMaximumSize()= 0;
Returns the maximum size for this View.

GetMinimumSize

public virtual CefSize GetMinimumSize()= 0;
Returns the minimum size for this View.

GetParentView

public virtual CefRefPtr< CefView > GetParentView()= 0;
Returns the View that contains this View, if any.

GetPosition

public virtual CefPoint GetPosition()= 0;
Returns the position of this View. Position is in parent coordinates.

GetPreferredSize

public virtual CefSize GetPreferredSize()= 0;
Returns the size this View would like to be if enough space is available.

GetSize

public virtual CefSize GetSize()= 0;
Returns the size of this View.

GetTypeString

public virtual CefString GetTypeString()= 0;
Returns the type of this View as a string. Used primarily for testing purposes.

GetViewForID

public virtual CefRefPtr< CefView > GetViewForID( int id )= 0;
Recursively descends the view tree starting at this View, and returns the first child that it encounters with the given ID. Returns NULL if no matching child view is found.

GetWindow

public virtual CefRefPtr< CefWindow > GetWindow()= 0;
Returns the top-level Window hosting this View, if any.

InvalidateLayout

public virtual void InvalidateLayout()= 0;
Indicate that this View and all parent Views require a re-layout. This ensures the next call to Layout() will propagate to this View even if the bounds of parent Views do not change.

IsAccessibilityFocusable

public virtual bool IsAccessibilityFocusable()= 0;
Return whether this View is focusable when the user requires full keyboard access, even though it may not be normally focusable.

IsAttached

public virtual bool IsAttached()= 0;
Returns true if this View is currently attached to another View. A View can only be attached to one View at a time.

IsDrawn

public virtual bool IsDrawn()= 0;
Returns whether this View is visible and drawn in a Window. A view is drawn if it and all parent views are visible. If this View is a Window then calling this method is equivalent to calling IsVisible(). Otherwise, to determine if the containing Window is visible to the user on-screen call IsVisible() on the Window.

IsEnabled

public virtual bool IsEnabled()= 0;
Returns whether this View is enabled.

IsFocusable

public virtual bool IsFocusable()= 0;
Returns true if this View is focusable, enabled and drawn.

IsSame

public virtual bool IsSame( CefRefPtr< CefView > that )= 0;
Returns true if this View is the same as |that| View.

IsValid

public virtual bool IsValid()= 0;
Returns true if this View is valid.

IsVisible

public virtual bool IsVisible()= 0;
Returns whether this View is visible. A view may be visible but still not drawn in a Window if any parent views are hidden. If this View is a Window then a return value of true indicates that this Window is currently visible to the user on-screen. If this View is not a Window then call IsDrawn() to determine whether this View and all parent views are visible and will be drawn.

RequestFocus

public virtual void RequestFocus()= 0;
Request keyboard focus. If this View is focusable it will become the focused View.

SetBackgroundColor

public virtual void SetBackgroundColor( cef_color_t color )= 0;
Sets the background color for this View.

SetBounds

public virtual void SetBounds( const CefRect& bounds )= 0;
Sets the bounds (size and position) of this View. Position is in parent coordinates.

SetEnabled

public virtual void SetEnabled( bool enabled )= 0;
Set whether this View is enabled. A disabled View does not receive keyboard or mouse inputs. If |enabled| differs from the current value the View will be repainted. Also, clears focus if the focused View is disabled.

SetFocusable

public virtual void SetFocusable( bool focusable )= 0;
Sets whether this View is capable of taking focus. It will clear focus if the focused View is set to be non-focusable. This is false by default so that a View used as a container does not get the focus.

SetGroupID

public virtual void SetGroupID( int group_id )= 0;
A group id is used to tag Views which are part of the same logical group. Focus can be moved between views with the same group using the arrow keys. The group id is immutable once it's set.

SetID

public virtual void SetID( int id )= 0;
Sets the ID for this View. ID should be unique within the subtree that you intend to search for it. 0 is the default ID for views.

SetPosition

public virtual void SetPosition( const CefPoint& position )= 0;
Sets the position of this View without changing the size. |position| is in parent coordinates.

SetSize

public virtual void SetSize( const CefSize& size )= 0;
Sets the size of this View without changing the position.

SetVisible

public virtual void SetVisible( bool visible )= 0;
Sets whether this View is visible. Windows are hidden by default and other views are visible by default. This View and any parent views must be set as visible for this View to be drawn in a Window. If this View is set as hidden then it and any child views will not be drawn and, if any of those views currently have focus, then focus will also be cleared. Painting is scheduled as needed. If this View is a Window then calling this method is equivalent to calling the Window Show() and Hide() methods.

SizeToPreferredSize

public virtual void SizeToPreferredSize()= 0;
Size this View to its preferred size.

ToString

public virtual CefString ToString( bool include_children )= 0;
Returns a string representation of this View which includes the type and various type-specific identifying attributes. If |include_children| is true any child Views will also be included. Used primarily for testing purposes.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt