Class TCEFViewComponent

Description
Hierarchy
Fields
Methods
Properties

Unit

uCEFViewComponent

Declaration

type TCEFViewComponent = class(TComponent, ICefViewDelegateEvents)

Description

This item has no description.

Hierarchy

Overview

Fields

Protected FOnGetPreferredSize: TOnGetPreferredSizeEvent;
Protected FOnGetMinimumSize: TOnGetMinimumSizeEvent;
Protected FOnGetMaximumSize: TOnGetMaximumSizeEvent;
Protected FOnGetHeightForWidth: TOnGetHeightForWidthEvent;
Protected FOnParentViewChanged: TOnParentViewChangedEvent;
Protected FOnChildViewChanged: TOnChildViewChangedEvent;
Protected FOnWindowChanged: TOnWindowChangedEvent;
Protected FOnLayoutChanged: TOnLayoutChangedEvent;
Protected FOnFocus: TOnFocusEvent;
Protected FOnBlur: TOnBlurEvent;
Protected FOnThemeChanged: TOnThemeChangedEvent;
Protected FComponentID: integer;

Methods

Protected procedure CreateView; virtual;
Protected procedure DestroyView; virtual;
Protected procedure Initialize; virtual;
Protected function GetInitialized: boolean; virtual;
Protected function GetAsView: ICefView; virtual;
Protected function GetTypeString: ustring;
Protected function GetAsBrowserView: ICefBrowserView; virtual;
Protected function GetAsButton: ICefButton; virtual;
Protected function GetAsPanel: ICefPanel; virtual;
Protected function GetAsScrollView: ICefScrollView; virtual;
Protected function GetAsTextfield: ICefTextfield; virtual;
Protected function GetIsValid: boolean;
Protected function GetIsAttached: boolean;
Protected function GetDelegate: ICefViewDelegate;
Protected function GetWindow: ICefWindow;
Protected function GetID: Integer;
Protected function GetGroupID: Integer;
Protected function GetParentView: ICefView;
Protected function GetBounds: TCefRect;
Protected function GetBoundsInScreen: TCefRect;
Protected function GetSize: TCefSize;
Protected function GetPosition: TCefPoint;
Protected function GetPreferredSize: TCefSize;
Protected function GetMinimumSize: TCefSize;
Protected function GetMaximumSize: TCefSize;
Protected function GetIsVisible: boolean;
Protected function GetIsDrawn: boolean;
Protected function GetIsEnabled: boolean;
Protected function GetIsFocusable: boolean;
Protected function GetIsAccessibilityFocusable: boolean;
Protected function GetBackgroundColor: TCefColor;
Protected function GetViewForID(id_: Integer): ICefView;
Protected function GetHeightForWidth(width: Integer): Integer;
Protected function GetInsets: TCefInsets;
Protected function GetComponentID: integer;
Protected procedure SetID(id_: Integer);
Protected procedure SetGroupID(group_id: Integer);
Protected procedure SetBounds(const bounds_: TCefRect);
Protected procedure SetSize(const size_: TCefSize);
Protected procedure SetPosition(const position_: TCefPoint);
Protected procedure SetVisible(visible_: boolean);
Protected procedure SetEnabled(enabled_: boolean);
Protected procedure SetFocusable(focusable_: boolean);
Protected procedure SetBackgroundColor(color: TCefColor);
Protected procedure SetInsets(const insets: TCefInsets);
Protected procedure doOnGetPreferredSize(const view: ICefView; var aResult : TCefSize); virtual;
Protected procedure doOnGetMinimumSize(const view: ICefView; var aResult : TCefSize); virtual;
Protected procedure doOnGetMaximumSize(const view: ICefView; var aResult : TCefSize); virtual;
Protected procedure doOnGetHeightForWidth(const view: ICefView; width: Integer; var aResult: Integer); virtual;
Protected procedure doOnParentViewChanged(const view: ICefView; added: boolean; const parent: ICefView); virtual;
Protected procedure doOnChildViewChanged(const view: ICefView; added: boolean; const child: ICefView); virtual;
Protected procedure doOnWindowChanged(const view: ICefView; added: boolean); virtual;
Protected procedure doOnLayoutChanged(const view: ICefView; new_bounds: TCefRect); virtual;
Protected procedure doOnFocus(const view: ICefView); virtual;
Protected procedure doOnBlur(const view: ICefView); virtual;
Protected procedure doOnThemeChanged(const view: ICefView); virtual;
Protected procedure doCreateCustomView; virtual;
Public constructor Create(AOwner: TComponent); override;
Public procedure AfterConstruction; override;
Public procedure BeforeDestruction; override;
Public function ToStringEx(include_children: boolean): ustring;
Public function IsSame(const that: ICefView): boolean;
Public procedure SizeToPreferredSize;
Public procedure InvalidateLayout;
Public procedure RequestFocus;
Public function GetThemeColor(color_id: integer): TCefColor;
Public function ConvertPointToScreen(var point: TCefPoint): boolean;
Public function ConvertPointFromScreen(var point: TCefPoint): boolean;
Public function ConvertPointToWindow(var point: TCefPoint): boolean;
Public function ConvertPointFromWindow(var point: TCefPoint): boolean;
Public function ConvertPointToView(const view : ICefView; var point: TCefPoint): boolean;
Public function ConvertPointFromView(const view : ICefView; var point: TCefPoint): boolean;

Properties

Public property Initialized : boolean read GetInitialized;
Public property AsView : ICefView read GetAsView;
Public property AsBrowserView : ICefBrowserView read GetAsBrowserView;
Public property AsButton : ICefButton read GetAsButton;
Public property AsPanel : ICefPanel read GetAsPanel;
Public property AsScrollView : ICefScrollView read GetAsScrollView;
Public property AsTextfield : ICefTextfield read GetAsTextfield;
Public property ViewForID[id_: Integer]: ICefView read GetViewForID;
Public property Valid : boolean read GetIsValid;
Public property Attached : boolean read GetIsAttached;
Public property Delegate : ICefViewDelegate read GetDelegate;
Public property Window : ICefWindow read GetWindow;
Public property ParentView : ICefView read GetParentView;
Public property BoundsInScreen : TCefRect read GetBoundsInScreen;
Public property PreferredSize : TCefSize read GetPreferredSize;
Public property MinimumSize : TCefSize read GetMinimumSize;
Public property MaximumSize : TCefSize read GetMaximumSize;
Public property Visible : boolean read GetIsVisible write SetVisible;
Public property Drawn : boolean read GetIsDrawn;
Public property Enabled : boolean read GetIsEnabled write SetEnabled;
Public property Focusable : boolean read GetIsFocusable write SetFocusable;
Public property AccessibilityFocusable : boolean read GetIsAccessibilityFocusable;
Public property BackgroundColor : TCefColor read GetBackgroundColor write SetBackgroundColor;
Public property ID : integer read GetID write SetID;
Public property GroupID : integer read GetGroupID write SetGroupID;
Public property Bounds : TCefRect read GetBounds write SetBounds;
Public property Size : TCefSize read GetSize write SetSize;
Public property Position : TCefPoint read GetPosition write SetPosition;
Public property Insets : TCefInsets read GetInsets write SetInsets;
Public property TypeString : ustring read GetTypeString;
Public property HeightForWidth[width: Integer]: Integer read GetHeightForWidth;
Published property OnGetPreferredSize : TOnGetPreferredSizeEvent read FOnGetPreferredSize write FOnGetPreferredSize;
Published property OnGetMinimumSize : TOnGetMinimumSizeEvent read FOnGetMinimumSize write FOnGetMinimumSize;
Published property OnGetMaximumSize : TOnGetMaximumSizeEvent read FOnGetMaximumSize write FOnGetMaximumSize;
Published property OnGetHeightForWidth : TOnGetHeightForWidthEvent read FOnGetHeightForWidth write FOnGetHeightForWidth;
Published property OnParentViewChanged : TOnParentViewChangedEvent read FOnParentViewChanged write FOnParentViewChanged;
Published property OnChildViewChanged : TOnChildViewChangedEvent read FOnChildViewChanged write FOnChildViewChanged;
Published property OnWindowChanged : TOnWindowChangedEvent read FOnWindowChanged write FOnWindowChanged;
Published property OnLayoutChanged : TOnLayoutChangedEvent read FOnLayoutChanged write FOnLayoutChanged;
Published property OnFocus : TOnFocusEvent read FOnFocus write FOnFocus;
Published property OnBlur : TOnBlurEvent read FOnBlur write FOnBlur;
Published property OnThemeChanged : TOnThemeChangedEvent read FOnThemeChanged write FOnThemeChanged;

Description

Fields

Protected FOnGetPreferredSize: TOnGetPreferredSizeEvent;

ICefViewDelegateEvents

Protected FOnGetMinimumSize: TOnGetMinimumSizeEvent;

This item has no description.

Protected FOnGetMaximumSize: TOnGetMaximumSizeEvent;

This item has no description.

Protected FOnGetHeightForWidth: TOnGetHeightForWidthEvent;

This item has no description.

Protected FOnParentViewChanged: TOnParentViewChangedEvent;

This item has no description.

Protected FOnChildViewChanged: TOnChildViewChangedEvent;

This item has no description.

Protected FOnWindowChanged: TOnWindowChangedEvent;

This item has no description.

Protected FOnLayoutChanged: TOnLayoutChangedEvent;

This item has no description.

Protected FOnFocus: TOnFocusEvent;

This item has no description.

Protected FOnBlur: TOnBlurEvent;

This item has no description.

Protected FOnThemeChanged: TOnThemeChangedEvent;

This item has no description.

Protected FComponentID: integer;

This item has no description.

Methods

Protected procedure CreateView; virtual;

This item has no description.

Protected procedure DestroyView; virtual;

This item has no description.

Protected procedure Initialize; virtual;

This item has no description.

Protected function GetInitialized: boolean; virtual;

This item has no description.

Protected function GetAsView: ICefView; virtual;

This item has no description.

Protected function GetTypeString: ustring;

This item has no description.

Protected function GetAsBrowserView: ICefBrowserView; virtual;

This item has no description.

Protected function GetAsButton: ICefButton; virtual;

This item has no description.

Protected function GetAsPanel: ICefPanel; virtual;

This item has no description.

Protected function GetAsScrollView: ICefScrollView; virtual;

This item has no description.

Protected function GetAsTextfield: ICefTextfield; virtual;

This item has no description.

Protected function GetIsValid: boolean;

This item has no description.

Protected function GetIsAttached: boolean;

This item has no description.

Protected function GetDelegate: ICefViewDelegate;

This item has no description.

Protected function GetWindow: ICefWindow;

This item has no description.

Protected function GetID: Integer;

This item has no description.

Protected function GetGroupID: Integer;

This item has no description.

Protected function GetParentView: ICefView;

This item has no description.

Protected function GetBounds: TCefRect;

This item has no description.

Protected function GetBoundsInScreen: TCefRect;

This item has no description.

Protected function GetSize: TCefSize;

This item has no description.

Protected function GetPosition: TCefPoint;

This item has no description.

Protected function GetPreferredSize: TCefSize;

This item has no description.

Protected function GetMinimumSize: TCefSize;

This item has no description.

Protected function GetMaximumSize: TCefSize;

This item has no description.

Protected function GetIsVisible: boolean;

This item has no description.

Protected function GetIsDrawn: boolean;

This item has no description.

Protected function GetIsEnabled: boolean;

This item has no description.

Protected function GetIsFocusable: boolean;

This item has no description.

Protected function GetIsAccessibilityFocusable: boolean;

This item has no description.

Protected function GetBackgroundColor: TCefColor;

This item has no description.

Protected function GetViewForID(id_: Integer): ICefView;

This item has no description.

Protected function GetHeightForWidth(width: Integer): Integer;

This item has no description.

Protected function GetInsets: TCefInsets;

This item has no description.

Protected function GetComponentID: integer;

This item has no description.

Protected procedure SetID(id_: Integer);

This item has no description.

Protected procedure SetGroupID(group_id: Integer);

This item has no description.

Protected procedure SetBounds(const bounds_: TCefRect);

This item has no description.

Protected procedure SetSize(const size_: TCefSize);

This item has no description.

Protected procedure SetPosition(const position_: TCefPoint);

This item has no description.

Protected procedure SetVisible(visible_: boolean);

This item has no description.

Protected procedure SetEnabled(enabled_: boolean);

This item has no description.

Protected procedure SetFocusable(focusable_: boolean);

This item has no description.

Protected procedure SetBackgroundColor(color: TCefColor);

This item has no description.

Protected procedure SetInsets(const insets: TCefInsets);

This item has no description.

Protected procedure doOnGetPreferredSize(const view: ICefView; var aResult : TCefSize); virtual;

ICefViewDelegateEvents

Protected procedure doOnGetMinimumSize(const view: ICefView; var aResult : TCefSize); virtual;

This item has no description.

Protected procedure doOnGetMaximumSize(const view: ICefView; var aResult : TCefSize); virtual;

This item has no description.

Protected procedure doOnGetHeightForWidth(const view: ICefView; width: Integer; var aResult: Integer); virtual;

This item has no description.

Protected procedure doOnParentViewChanged(const view: ICefView; added: boolean; const parent: ICefView); virtual;

This item has no description.

Protected procedure doOnChildViewChanged(const view: ICefView; added: boolean; const child: ICefView); virtual;

This item has no description.

Protected procedure doOnWindowChanged(const view: ICefView; added: boolean); virtual;

This item has no description.

Protected procedure doOnLayoutChanged(const view: ICefView; new_bounds: TCefRect); virtual;

This item has no description.

Protected procedure doOnFocus(const view: ICefView); virtual;

This item has no description.

Protected procedure doOnBlur(const view: ICefView); virtual;

This item has no description.

Protected procedure doOnThemeChanged(const view: ICefView); virtual;

This item has no description.

Protected procedure doCreateCustomView; virtual;

This item has no description. Showing description inherited from ICefViewDelegateEvents.doCreateCustomView.

Custom

Public constructor Create(AOwner: TComponent); override;

This item has no description.

Public procedure AfterConstruction; override;

This item has no description.

Public procedure BeforeDestruction; override;

This item has no description.

Public function ToStringEx(include_children: boolean): ustring;

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

Public function IsSame(const that: ICefView): boolean;

Returns true (1) if this View is the same as |that| View.

Public procedure SizeToPreferredSize;

Size this View to its preferred size. Size is in parent coordinates, or DIP screen coordinates if there is no parent.

Public procedure InvalidateLayout;

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.

Public procedure RequestFocus;

Request keyboard focus. If this View is focusable it will become the focused View.

Public function GetThemeColor(color_id: integer): TCefColor;

Returns the current theme color associated with |color_id|, or the placeholder color (red) if unset. See cef_color_ids.h for standard ID values. Standard colors can be overridden and custom colors can be added using ICefWindow.SetThemeColor.

Public function ConvertPointToScreen(var point: TCefPoint): boolean;

Convert |point| from this View's coordinate system to DIP screen coordinates. This View must belong to a Window when calling this function. Returns true (1) if the conversion is successful or false (0) otherwise. Use ICefDisplay.ConvertPointToPixels() after calling this function if further conversion to display-specific pixel coordinates is desired.

Public function ConvertPointFromScreen(var point: TCefPoint): boolean;

Convert |point| to this View's coordinate system from DIP screen coordinates. This View must belong to a Window when calling this function. Returns true (1) if the conversion is successful or false (0) otherwise. Use ICefDisplay.ConvertPointFromPixels() before calling this function if conversion from display-specific pixel coordinates is necessary.

Public function ConvertPointToWindow(var point: TCefPoint): boolean;

Convert |point| from this View's coordinate system to that of the Window. This View must belong to a Window when calling this function. Returns true (1) if the conversion is successful or false (0) otherwise.

Public function ConvertPointFromWindow(var point: TCefPoint): boolean;

Convert |point| to this View's coordinate system from that of the Window. This View must belong to a Window when calling this function. Returns true (1) if the conversion is successful or false (0) otherwise.

Public function ConvertPointToView(const view : ICefView; var point: TCefPoint): boolean;

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 (1) if the conversion is successful or false (0) otherwise.

Public function ConvertPointFromView(const view : ICefView; var point: TCefPoint): boolean;

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 (1) if the conversion is successful or false (0) otherwise.

Properties

Public property Initialized : boolean read GetInitialized;

Returns true when the control is fully initialized.

Public property AsView : ICefView read GetAsView;

Returns this control as a View.

Public property AsBrowserView : ICefBrowserView read GetAsBrowserView;

Returns this View as a BrowserView or NULL if this is not a BrowserView.

Public property AsButton : ICefButton read GetAsButton;

Returns this View as a Button or NULL if this is not a Button.

Public property AsPanel : ICefPanel read GetAsPanel;

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

Public property AsScrollView : ICefScrollView read GetAsScrollView;

Returns this View as a ScrollView or NULL if this is not a ScrollView.

Public property AsTextfield : ICefTextfield read GetAsTextfield;

Returns this View as a Textfield or NULL if this is not a Textfield.

Public property ViewForID[id_: Integer]: ICefView read GetViewForID;

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.

Public property Valid : boolean read GetIsValid;

Returns true (1) if this View is valid.

Public property Attached : boolean read GetIsAttached;

Returns true (1) if this View is currently attached to another View. A View can only be attached to one View at a time.

Public property Delegate : ICefViewDelegate read GetDelegate;

Returns the delegate associated with this View, if any.

Public property Window : ICefWindow read GetWindow;

Returns the top-level Window hosting this View, if any.

Public property ParentView : ICefView read GetParentView;

Returns the View that contains this View, if any.

Public property BoundsInScreen : TCefRect read GetBoundsInScreen;

Returns the bounds (size and position) of this View in DIP screen coordinates.

Public property PreferredSize : TCefSize read GetPreferredSize;

Returns the size this View would like to be if enough space is available. Size is in parent coordinates, or DIP screen coordinates if there is no parent.

Public property MinimumSize : TCefSize read GetMinimumSize;

Returns the minimum size for this View. Size is in parent coordinates, or DIP screen coordinates if there is no parent.

Public property MaximumSize : TCefSize read GetMaximumSize;

Returns the maximum size for this View. Size is in parent coordinates, or DIP screen coordinates if there is no parent.

Public property Visible : boolean read GetIsVisible write SetVisible;

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 (1) indicates that this Window is currently visible to the user on-screen. If this View is not a Window then call is_drawn() to determine whether this View and all parent views are visible and will be drawn.

Public property Drawn : boolean read GetIsDrawn;

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 function is equivalent to calling is_visible(). Otherwise, to determine if the containing Window is visible to the user on-screen call is_visible() on the Window.

Public property Enabled : boolean read GetIsEnabled write SetEnabled;

Get or 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.

Public property Focusable : boolean read GetIsFocusable write SetFocusable;

Gets and 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 (0) by default so that a View used as a container does not get the focus.

Public property AccessibilityFocusable : boolean read GetIsAccessibilityFocusable;

Return whether this View is focusable when the user requires full keyboard access, even though it may not be normally focusable.

Public property BackgroundColor : TCefColor read GetBackgroundColor write SetBackgroundColor;

Returns the background color for this View. If the background color is unset then the current `GetThemeColor(CEF_ColorPrimaryBackground)` value will be returned. If this View belongs to an overlay (created with ICefWindow.AddOverlayView), and the background color is unset, then a value of transparent (0) will be returned.

Public property ID : integer read GetID write SetID;

Gets or 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.

Public property GroupID : integer read GetGroupID write SetGroupID;

Returns the group id of this View, or -1 if not set.

Public property Bounds : TCefRect read GetBounds write SetBounds;

Returns the bounds (size and position) of this View in parent coordinates, or DIP screen coordinates if there is no parent.

Public property Size : TCefSize read GetSize write SetSize;

Returns the size of this View in parent coordinates, or DIP screen coordinates if there is no parent.

Public property Position : TCefPoint read GetPosition write SetPosition;

Returns the position of this View. Position is in parent coordinates, or DIP screen coordinates if there is no parent.

Public property Insets : TCefInsets read GetInsets write SetInsets;

Returns the insets for this View in parent coordinates, or DIP screen coordinates if there is no parent.

Public property TypeString : ustring read GetTypeString;

Returns the type of this View as a string. Used primarily for testing purposes.

Public property HeightForWidth[width: Integer]: Integer read GetHeightForWidth;

Returns the height necessary to display this View with the provided width.

Published property OnGetPreferredSize : TOnGetPreferredSizeEvent read FOnGetPreferredSize write FOnGetPreferredSize;

Return the preferred size for |view|. The Layout will use this information to determine the display size.

Published property OnGetMinimumSize : TOnGetMinimumSizeEvent read FOnGetMinimumSize write FOnGetMinimumSize;

Return the minimum size for |view|.

Published property OnGetMaximumSize : TOnGetMaximumSizeEvent read FOnGetMaximumSize write FOnGetMaximumSize;

Return the maximum size for |view|.

Published property OnGetHeightForWidth : TOnGetHeightForWidthEvent read FOnGetHeightForWidth write FOnGetHeightForWidth;

Return the height necessary to display |view| with the provided |width|. If not specified the result of get_preferred_size().height will be used by default. Override if |view|'s preferred height depends upon the width (for example, with Labels).

Published property OnParentViewChanged : TOnParentViewChangedEvent read FOnParentViewChanged write FOnParentViewChanged;

Called when the parent of |view| has changed. If |view| is being added to |parent| then |added| will be true (1). If |view| is being removed from |parent| then |added| will be false (0). If |view| is being reparented the remove notification will be sent before the add notification. Do not modify the view hierarchy in this callback.

Published property OnChildViewChanged : TOnChildViewChangedEvent read FOnChildViewChanged write FOnChildViewChanged;

Called when a child of |view| has changed. If |child| is being added to |view| then |added| will be true (1). If |child| is being removed from |view| then |added| will be false (0). If |child| is being reparented the remove notification will be sent to the old parent before the add notification is sent to the new parent. Do not modify the view hierarchy in this callback.

Published property OnWindowChanged : TOnWindowChangedEvent read FOnWindowChanged write FOnWindowChanged;

Called when |view| is added or removed from the ICefWindow.

Published property OnLayoutChanged : TOnLayoutChangedEvent read FOnLayoutChanged write FOnLayoutChanged;

Called when the layout of |view| has changed.

Published property OnFocus : TOnFocusEvent read FOnFocus write FOnFocus;

Called when |view| gains focus.

Published property OnBlur : TOnBlurEvent read FOnBlur write FOnBlur;

Called when |view| loses focus.

Published property OnThemeChanged : TOnThemeChangedEvent read FOnThemeChanged write FOnThemeChanged;

(

Called when the theme for |view| has changed, after the new theme colors have already been applied. Views are notified via the component hierarchy in depth-first reverse order (children before parents).

This will be called in the following cases: 

1. When |view|, or a parent of |view|, is added to a Window.
2. When the native/OS or Chrome theme changes for the Window that contains
   |view|. See ICefWindowDelegate.OnThemeColorsChanged documentation.
3. When the client explicitly calls ICefWindow.ThemeChanged on the
   Window that contains |view|.

Optionally use this callback to override the new per-View theme colors by calling ICefView.SetBackgroundColor or the appropriate component- specific function. See ICefWindow.SetThemeColor documentation for how to customize additional Window theme colors.

(

Generated by PasDoc 0.16.0-snapshot.