Chromium Embedded Framework (CEF)  126.2.0+g5c56e98+chromium-126.0.6478.62
CefPanel Class Referenceabstract

A Panel is a container in the views hierarchy that can contain other Views as children. More...

#include "include/views/cef_panel.h"

Inheritance diagram for CefPanel:
CefView CefBaseRefCounted CefWindow

Public Member Functions

virtual CefRefPtr< CefWindowAsWindow ()=0
 Returns this Panel as a Window or NULL if this is not a Window. More...
 
virtual CefRefPtr< CefFillLayoutSetToFillLayout ()=0
 Set this Panel's Layout to FillLayout and return the FillLayout object. More...
 
virtual CefRefPtr< CefBoxLayoutSetToBoxLayout (const CefBoxLayoutSettings &settings)=0
 Set this Panel's Layout to BoxLayout and return the BoxLayout object. More...
 
virtual CefRefPtr< CefLayoutGetLayout ()=0
 Get the Layout. More...
 
virtual void Layout ()=0
 Lay out the child Views (set their bounds based on sizing heuristics specific to the current Layout). More...
 
virtual void AddChildView (CefRefPtr< CefView > view)=0
 Add a child View. More...
 
virtual void AddChildViewAt (CefRefPtr< CefView > view, int index)=0
 Add a child View at the specified |index|. More...
 
virtual void ReorderChildView (CefRefPtr< CefView > view, int index)=0
 Move the child View to the specified |index|. More...
 
virtual void RemoveChildView (CefRefPtr< CefView > view)=0
 Remove a child View. More...
 
virtual void RemoveAllChildViews ()=0
 Remove all child Views. More...
 
virtual size_t GetChildViewCount ()=0
 Returns the number of child Views. More...
 
virtual CefRefPtr< CefViewGetChildViewAt (int index)=0
 Returns the child View at the specified |index|. More...
 
- Public Member Functions inherited from CefView
virtual CefRefPtr< CefBrowserViewAsBrowserView ()=0
 Returns this View as a BrowserView or NULL if this is not a BrowserView. More...
 
virtual CefRefPtr< CefButtonAsButton ()=0
 Returns this View as a Button or NULL if this is not a Button. More...
 
virtual CefRefPtr< CefPanelAsPanel ()=0
 Returns this View as a Panel or NULL if this is not a Panel. More...
 
virtual CefRefPtr< CefScrollViewAsScrollView ()=0
 Returns this View as a ScrollView or NULL if this is not a ScrollView. More...
 
virtual CefRefPtr< CefTextfieldAsTextfield ()=0
 Returns this View as a Textfield or NULL if this is not a Textfield. More...
 
virtual CefString GetTypeString ()=0
 Returns the type of this View as a string. More...
 
virtual CefString ToString (bool include_children)=0
 Returns a string representation of this View which includes the type and various type-specific identifying attributes. More...
 
virtual bool IsValid ()=0
 Returns true if this View is valid. More...
 
virtual bool IsAttached ()=0
 Returns true if this View is currently attached to another View. More...
 
virtual bool IsSame (CefRefPtr< CefView > that)=0
 Returns true if this View is the same as |that| View. More...
 
virtual CefRefPtr< CefViewDelegateGetDelegate ()=0
 Returns the delegate associated with this View, if any. More...
 
virtual CefRefPtr< CefWindowGetWindow ()=0
 Returns the top-level Window hosting this View, if any. More...
 
virtual int GetID ()=0
 Returns the ID for this View. More...
 
virtual void SetID (int id)=0
 Sets the ID for this View. More...
 
virtual int GetGroupID ()=0
 Returns the group id of this View, or -1 if not set. More...
 
virtual void SetGroupID (int group_id)=0
 A group id is used to tag Views which are part of the same logical group. More...
 
virtual CefRefPtr< CefViewGetParentView ()=0
 Returns the View that contains this View, if any. More...
 
virtual CefRefPtr< CefViewGetViewForID (int id)=0
 Recursively descends the view tree starting at this View, and returns the first child that it encounters with the given ID. More...
 
virtual void SetBounds (const CefRect &bounds)=0
 Sets the bounds (size and position) of this View. More...
 
virtual CefRect GetBounds ()=0
 Returns the bounds (size and position) of this View in parent coordinates, or DIP screen coordinates if there is no parent. More...
 
virtual CefRect GetBoundsInScreen ()=0
 Returns the bounds (size and position) of this View in DIP screen coordinates. More...
 
virtual void SetSize (const CefSize &size)=0
 Sets the size of this View without changing the position. More...
 
virtual CefSize GetSize ()=0
 Returns the size of this View in parent coordinates, or DIP screen coordinates if there is no parent. More...
 
virtual void SetPosition (const CefPoint &position)=0
 Sets the position of this View without changing the size. More...
 
virtual CefPoint GetPosition ()=0
 Returns the position of this View. More...
 
virtual void SetInsets (const CefInsets &insets)=0
 Sets the insets for this View. More...
 
virtual CefInsets GetInsets ()=0
 Returns the insets for this View in parent coordinates, or DIP screen coordinates if there is no parent. More...
 
virtual CefSize GetPreferredSize ()=0
 Returns the size this View would like to be if enough space is available. More...
 
virtual void SizeToPreferredSize ()=0
 Size this View to its preferred size. More...
 
virtual CefSize GetMinimumSize ()=0
 Returns the minimum size for this View. More...
 
virtual CefSize GetMaximumSize ()=0
 Returns the maximum size for this View. More...
 
virtual int GetHeightForWidth (int width)=0
 Returns the height necessary to display this View with the provided width. More...
 
virtual void InvalidateLayout ()=0
 Indicate that this View and all parent Views require a re-layout. More...
 
virtual void SetVisible (bool visible)=0
 Sets whether this View is visible. More...
 
virtual bool IsVisible ()=0
 Returns whether this View is visible. More...
 
virtual bool IsDrawn ()=0
 Returns whether this View is visible and drawn in a Window. More...
 
virtual void SetEnabled (bool enabled)=0
 Set whether this View is enabled. More...
 
virtual bool IsEnabled ()=0
 Returns whether this View is enabled. More...
 
virtual void SetFocusable (bool focusable)=0
 Sets whether this View is capable of taking focus. More...
 
virtual bool IsFocusable ()=0
 Returns true if this View is focusable, enabled and drawn. More...
 
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. More...
 
virtual void RequestFocus ()=0
 Request keyboard focus. More...
 
virtual void SetBackgroundColor (cef_color_t color)=0
 Sets the background color for this View. More...
 
virtual cef_color_t GetBackgroundColor ()=0
 Returns the background color for this View. More...
 
virtual cef_color_t GetThemeColor (int color_id)=0
 Returns the current theme color associated with |color_id|, or the placeholder color (red) if unset. More...
 
virtual bool ConvertPointToScreen (CefPoint &point)=0
 Convert |point| from this View's coordinate system to DIP screen coordinates. More...
 
virtual bool ConvertPointFromScreen (CefPoint &point)=0
 Convert |point| to this View's coordinate system from DIP screen coordinates. More...
 
virtual bool ConvertPointToWindow (CefPoint &point)=0
 Convert |point| from this View's coordinate system to that of the Window. More...
 
virtual bool ConvertPointFromWindow (CefPoint &point)=0
 Convert |point| to this View's coordinate system from that of the Window. More...
 
virtual bool ConvertPointToView (CefRefPtr< CefView > view, CefPoint &point)=0
 Convert |point| from this View's coordinate system to that of |view|. More...
 
virtual bool ConvertPointFromView (CefRefPtr< CefView > view, CefPoint &point)=0
 Convert |point| to this View's coordinate system from that |view|. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Static Public Member Functions

static CefRefPtr< CefPanelCreatePanel (CefRefPtr< CefPanelDelegate > delegate)
 Create a new Panel. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

A Panel is a container in the views hierarchy that can contain other Views as children.

Methods must be called on the browser process UI thread unless otherwise indicated.

Member Function Documentation

◆ AddChildView()

virtual void CefPanel::AddChildView ( CefRefPtr< CefView view)
pure virtual

Add a child View.

◆ AddChildViewAt()

virtual void CefPanel::AddChildViewAt ( CefRefPtr< CefView view,
int  index 
)
pure virtual

Add a child View at the specified |index|.

If |index| matches the result of GetChildCount() then the View will be added at the end.

◆ AsWindow()

virtual CefRefPtr<CefWindow> CefPanel::AsWindow ( )
pure virtual

Returns this Panel as a Window or NULL if this is not a Window.

◆ CreatePanel()

static CefRefPtr<CefPanel> CefPanel::CreatePanel ( CefRefPtr< CefPanelDelegate delegate)
static

Create a new Panel.

◆ GetChildViewAt()

virtual CefRefPtr<CefView> CefPanel::GetChildViewAt ( int  index)
pure virtual

Returns the child View at the specified |index|.

◆ GetChildViewCount()

virtual size_t CefPanel::GetChildViewCount ( )
pure virtual

Returns the number of child Views.

◆ GetLayout()

virtual CefRefPtr<CefLayout> CefPanel::GetLayout ( )
pure virtual

Get the Layout.

◆ Layout()

virtual void CefPanel::Layout ( )
pure virtual

Lay out the child Views (set their bounds based on sizing heuristics specific to the current Layout).

◆ RemoveAllChildViews()

virtual void CefPanel::RemoveAllChildViews ( )
pure virtual

Remove all child Views.

The removed Views will be deleted if the client holds no references to them.

◆ RemoveChildView()

virtual void CefPanel::RemoveChildView ( CefRefPtr< CefView view)
pure virtual

Remove a child View.

The View can then be added to another Panel.

◆ ReorderChildView()

virtual void CefPanel::ReorderChildView ( CefRefPtr< CefView view,
int  index 
)
pure virtual

Move the child View to the specified |index|.

A negative value for |index| will move the View to the end.

◆ SetToBoxLayout()

virtual CefRefPtr<CefBoxLayout> CefPanel::SetToBoxLayout ( const CefBoxLayoutSettings settings)
pure virtual

Set this Panel's Layout to BoxLayout and return the BoxLayout object.

◆ SetToFillLayout()

virtual CefRefPtr<CefFillLayout> CefPanel::SetToFillLayout ( )
pure virtual

Set this Panel's Layout to FillLayout and return the FillLayout object.


The documentation for this class was generated from the following file: