Chromium Embedded Framework (CEF)  106.0.15+gbb70d04+chromium-106.0.5249.12
CefBrowserView Class Referenceabstract

A View hosting a CefBrowser instance. More...

#include "include/views/cef_browser_view.h"

Inheritance diagram for CefBrowserView:
CefView CefBaseRefCounted

Public Member Functions

virtual CefRefPtr< CefBrowserGetBrowser ()=0
 Returns the CefBrowser hosted by this BrowserView. More...
 
virtual CefRefPtr< CefViewGetChromeToolbar ()=0
 Returns the Chrome toolbar associated with this BrowserView. More...
 
virtual void SetPreferAccelerators (bool prefer_accelerators)=0
 Sets whether accelerators registered with CefWindow::SetAccelerator are triggered before or after the event is sent to the CefBrowser. 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 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< CefBrowserViewCreateBrowserView (CefRefPtr< CefClient > client, const CefString &url, const CefBrowserSettings &settings, CefRefPtr< CefDictionaryValue > extra_info, CefRefPtr< CefRequestContext > request_context, CefRefPtr< CefBrowserViewDelegate > delegate)
 Create a new BrowserView. More...
 
static CefRefPtr< CefBrowserViewGetForBrowser (CefRefPtr< CefBrowser > browser)
 Returns the BrowserView associated with |browser|. More...
 

Additional Inherited Members

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

Detailed Description

A View hosting a CefBrowser instance.

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

Member Function Documentation

◆ CreateBrowserView()

static CefRefPtr<CefBrowserView> CefBrowserView::CreateBrowserView ( CefRefPtr< CefClient client,
const CefString url,
const CefBrowserSettings settings,
CefRefPtr< CefDictionaryValue extra_info,
CefRefPtr< CefRequestContext request_context,
CefRefPtr< CefBrowserViewDelegate delegate 
)
static

Create a new BrowserView.

The underlying CefBrowser will not be created until this view is added to the views hierarchy. The optional |extra_info| parameter provides an opportunity to specify extra information specific to the created browser that will be passed to CefRenderProcessHandler::OnBrowserCreated() in the render process.

◆ GetBrowser()

virtual CefRefPtr<CefBrowser> CefBrowserView::GetBrowser ( )
pure virtual

Returns the CefBrowser hosted by this BrowserView.

Will return NULL if the browser has not yet been created or has already been destroyed.

◆ GetChromeToolbar()

virtual CefRefPtr<CefView> CefBrowserView::GetChromeToolbar ( )
pure virtual

Returns the Chrome toolbar associated with this BrowserView.

Only supported when using the Chrome runtime. The CefBrowserViewDelegate:: GetChromeToolbarType() method must return a value other than CEF_CTT_NONE and the toolbar will not be available until after this BrowserView is added to a CefWindow and CefViewDelegate::OnWindowChanged() has been called.

◆ GetForBrowser()

static CefRefPtr<CefBrowserView> CefBrowserView::GetForBrowser ( CefRefPtr< CefBrowser browser)
static

Returns the BrowserView associated with |browser|.

◆ SetPreferAccelerators()

virtual void CefBrowserView::SetPreferAccelerators ( bool  prefer_accelerators)
pure virtual

Sets whether accelerators registered with CefWindow::SetAccelerator are triggered before or after the event is sent to the CefBrowser.

If |prefer_accelerators| is true then the matching accelerator will be triggered immediately and the event will not be sent to the CefBrowser. If |prefer_accelerators| is false then the matching accelerator will only be triggered if the event is not handled by web content or by CefKeyboardHandler. The default value is false.


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