CefScrollView Class Reference

A ScrollView will show horizontal and/or vertical scrollbars when necessary based on the size of the attached content view. More...

#include "include/views/cef_scroll_view.h"

Inheritance diagram for CefScrollView:

Public Member Functions
virtual void	SetContentView (CefRefPtr< CefView > view)=0
	Set the content View.
virtual CefRefPtr< CefView >	GetContentView ()=0
	Returns the content View.
virtual CefRect	GetVisibleContentRect ()=0
	Returns the visible region of the content View.
virtual bool	HasHorizontalScrollbar ()=0
	Returns true if the horizontal scrollbar is currently showing.
virtual int	GetHorizontalScrollbarHeight ()=0
	Returns the height of the horizontal scrollbar.
virtual bool	HasVerticalScrollbar ()=0
	Returns true if the vertical scrollbar is currently showing.
virtual int	GetVerticalScrollbarWidth ()=0
	Returns the width of the vertical scrollbar.
Public Member Functions inherited from CefView
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 CefString	GetTypeString ()=0
	Returns the type of this View as a string.
virtual CefString	ToString (bool include_children)=0
	Returns a string representation of this View which includes the type and various type-specific identifying attributes.
virtual bool	IsValid ()=0
	Returns true if this View is valid.
virtual bool	IsAttached ()=0
	Returns true if this View is currently attached to another View.
virtual bool	IsSame (CefRefPtr< CefView > that)=0
	Returns true if this View is the same as |that| View.
virtual CefRefPtr< CefViewDelegate >	GetDelegate ()=0
	Returns the delegate associated with this View, if any.
virtual CefRefPtr< CefWindow >	GetWindow ()=0
	Returns the top-level Window hosting this View, if any.
virtual int	GetID ()=0
	Returns the ID for this View.
virtual void	SetID (int id)=0
	Sets the ID for this View.
virtual int	GetGroupID ()=0
	Returns the group id of this View, or -1 if not set.
virtual void	SetGroupID (int group_id)=0
	A group id is used to tag Views which are part of the same logical group.
virtual CefRefPtr< CefView >	GetParentView ()=0
	Returns the View that contains this View, if any.
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 void	SetBounds (const CefRect &bounds)=0
	Sets the bounds (size and position) of this View.
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.
virtual CefRect	GetBoundsInScreen ()=0
	Returns the bounds (size and position) of this View in DIP screen coordinates.
virtual void	SetSize (const CefSize &size)=0
	Sets the size of this View without changing the position.
virtual CefSize	GetSize ()=0
	Returns the size of this View in parent coordinates, or DIP screen coordinates if there is no parent.
virtual void	SetPosition (const CefPoint &position)=0
	Sets the position of this View without changing the size.
virtual CefPoint	GetPosition ()=0
	Returns the position of this View.
virtual void	SetInsets (const CefInsets &insets)=0
	Sets the insets for this View.
virtual CefInsets	GetInsets ()=0
	Returns the insets for this View in parent coordinates, or DIP screen coordinates if there is no parent.
virtual CefSize	GetPreferredSize ()=0
	Returns the size this View would like to be if enough space is available.
virtual void	SizeToPreferredSize ()=0
	Size this View to its preferred size.
virtual CefSize	GetMinimumSize ()=0
	Returns the minimum size for this View.
virtual CefSize	GetMaximumSize ()=0
	Returns the maximum size for this View.
virtual int	GetHeightForWidth (int width)=0
	Returns the height necessary to display this View with the provided width.
virtual void	InvalidateLayout ()=0
	Indicate that this View and all parent Views require a re-layout.
virtual void	SetVisible (bool visible)=0
	Sets whether this View is visible.
virtual bool	IsVisible ()=0
	Returns whether this View is visible.
virtual bool	IsDrawn ()=0
	Returns whether this View is visible and drawn in a Window.
virtual void	SetEnabled (bool enabled)=0
	Set whether this View is enabled.
virtual bool	IsEnabled ()=0
	Returns whether this View is enabled.
virtual void	SetFocusable (bool focusable)=0
	Sets whether this View is capable of taking focus.
virtual bool	IsFocusable ()=0
	Returns true if this View is focusable, enabled and drawn.
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	HasFocus ()=0
	Returns true if this View has focus in the context of the containing Window.
virtual void	RequestFocus ()=0
	Request focus for this View in the context of the containing Window.
virtual void	SetBackgroundColor (cef_color_t color)=0
	Sets the background color for this View.
virtual cef_color_t	GetBackgroundColor ()=0
	Returns the background color for this View.
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.
virtual bool	ConvertPointToScreen (CefPoint &point)=0
	Convert |point| from this View's coordinate system to DIP screen coordinates.
virtual bool	ConvertPointFromScreen (CefPoint &point)=0
	Convert |point| to this View's coordinate system from DIP screen coordinates.
virtual bool	ConvertPointToWindow (CefPoint &point)=0
	Convert |point| from this View's coordinate system to that of the Window.
virtual bool	ConvertPointFromWindow (CefPoint &point)=0
	Convert |point| to this View's coordinate system from that of the Window.
virtual bool	ConvertPointToView (CefRefPtr< CefView > view, CefPoint &point)=0
	Convert |point| from this View's coordinate system to that of |view|.
virtual bool	ConvertPointFromView (CefRefPtr< CefView > view, CefPoint &point)=0
	Convert |point| to this View's coordinate system from that |view|.
Public Member Functions inherited from CefBaseRefCounted
virtual void	AddRef () const =0
	Called to increment the reference count for the object.
virtual bool	Release () const =0
	Called to decrement the reference count for the object.
virtual bool	HasOneRef () const =0
	Returns true if the reference count is 1.
virtual bool	HasAtLeastOneRef () const =0
	Returns true if the reference count is at least 1.

Static Public Member Functions
static CefRefPtr< CefScrollView >	CreateScrollView (CefRefPtr< CefViewDelegate > delegate)
	Create a new ScrollView.

Additional Inherited Members
Protected Member Functions inherited from CefBaseRefCounted
virtual	~CefBaseRefCounted ()

Detailed Description

A ScrollView will show horizontal and/or vertical scrollbars when necessary based on the size of the attached content view.

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

Member Function Documentation

CreateScrollView()

static CefRefPtr< CefScrollView > CefScrollView::CreateScrollView ( CefRefPtr< CefViewDelegate >  delegate )

static

Create a new ScrollView.

GetContentView()

virtual CefRefPtr< CefView > CefScrollView::GetContentView ( )

pure virtual

Returns the content View.

GetHorizontalScrollbarHeight()

virtual int CefScrollView::GetHorizontalScrollbarHeight ( )

pure virtual

Returns the height of the horizontal scrollbar.

GetVerticalScrollbarWidth()

virtual int CefScrollView::GetVerticalScrollbarWidth ( )

pure virtual

Returns the width of the vertical scrollbar.

GetVisibleContentRect()

virtual CefRect CefScrollView::GetVisibleContentRect ( )

pure virtual

Returns the visible region of the content View.

HasHorizontalScrollbar()

virtual bool CefScrollView::HasHorizontalScrollbar ( )

pure virtual

Returns true if the horizontal scrollbar is currently showing.

HasVerticalScrollbar()

virtual bool CefScrollView::HasVerticalScrollbar ( )

pure virtual

Returns true if the vertical scrollbar is currently showing.

SetContentView()

virtual void CefScrollView::SetContentView ( CefRefPtr< CefView >  view )

pure virtual

Set the content View.

The content View must have a specified size (e.g. via CefView::SetBounds or CefViewDelegate::GetPreferredSize).

---

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

• include/views/cef_scroll_view.h