# Interface ICefOverlayController

Description
Hierarchy
Fields
Methods
Properties

## Unit

uCEFInterfaces

## Declaration

`type ICefOverlayController = interface(ICefBaseRefCounted)`

## Description

Controller for an overlay that contains a contents View added via ICefWindow.AddOverlayView. Methods exposed by this controller should be called in preference to functions of the same name exposed by the contents View unless otherwise indicated. Methods must be called on the browser process UI thread unless otherwise indicated.

UNKNOWN

<see href="https://bitbucket.org/chromiumembedded/cef/src/master/include/capi/views/cef_overlay_controller_capi.h">CEF source file: /include/capi/views/cef_overlay_controller_capi.h (cef_overlay_controller_t))

## Hierarchy

- IInterface
- ICefBaseRefCounted
- ICefOverlayController

## Overview

### Methods

| `function IsValid: boolean;`
| `function IsSame(const that: ICefOverlayController): boolean;`
| `function GetContentsView: ICefView;`
| `function GetWindow: ICefWindow;`
| `function GetDockingMode: TCefDockingMode;`
| `procedure DestroyOverlay;`
| `procedure SetBounds(const bounds: TCefRect);`
| `function GetBounds: TCefRect;`
| `function GetBoundsInScreen: TCefRect;`
| `procedure SetSize(const size: TCefSize);`
| `function GetSize: TCefSize;`
| `procedure SetPosition(const position: TCefPoint);`
| `function GetPosition: TCefPoint;`
| `procedure SetInsets(const insets: TCefInsets);`
| `function GetInsets: TCefInsets;`
| `procedure SizeToPreferredSize;`
| `procedure SetVisible(visible: boolean);`
| `function IsVisible: boolean;`
| `function IsDrawn: boolean;`

### Properties

| `property ContentsView : ICefView read GetContentsView;`
| `property Window : ICefWindow read GetWindow;`
| `property DockingMode : TCefDockingMode read GetDockingMode;`
| `property Bounds : TCefRect read GetBounds write SetBounds;`
| `property BoundsInScreen : TCefRect read GetBoundsInScreen;`
| `property Size : TCefSize read GetSize write SetSize;`
| `property Position : TCefPoint read GetPosition write SetPosition;`
| `property Insets : TCefInsets read GetInsets write SetInsets;`
| `property Visible : boolean read IsVisible write SetVisible;`
| `property Drawn : boolean read IsDrawn;`

## Description

### Methods

| `function IsValid: boolean;`
Returns true (1) if this object is valid. ###### Attributes GUID['{13E1F3D2-32FF-4D30-A30E-D67B6A4846AB}']

| `function IsSame(const that: ICefOverlayController): boolean;`
Returns true (1) if this object is the same as |that| object.

| `function GetContentsView: ICefView;`
Returns the contents View for this overlay.

| `function GetWindow: ICefWindow;`
Returns the top-level Window hosting this overlay. Use this function instead of calling get_window() on the contents View.

| `function GetDockingMode: TCefDockingMode;`
Returns the docking mode for this overlay.

| `procedure DestroyOverlay;`
Destroy this overlay.

| `procedure SetBounds(const bounds: TCefRect);`
Sets the bounds (size and position) of this overlay. This will set the bounds of the contents View to match and trigger a re-layout if necessary. |bounds| is in parent coordinates and any insets configured on this overlay will be ignored. Use this function only for overlays created with a docking mode value of CEF_DOCKING_MODE_CUSTOM. With other docking modes modify the insets of this overlay and/or layout of the contents View and call size_to_preferred_size() instead to calculate the new size and re- position the overlay if necessary.

| `function GetBounds: TCefRect;`
Returns the bounds (size and position) of this overlay in parent coordinates.

| `function GetBoundsInScreen: TCefRect;`
Returns the bounds (size and position) of this overlay in DIP screen coordinates.

| `procedure SetSize(const size: TCefSize);`
Sets the size of this overlay without changing the position. This will set the size of the contents View to match and trigger a re-layout if necessary. |size| is in parent coordinates and any insets configured on this overlay will be ignored. Use this function only for overlays created with a docking mode value of CEF_DOCKING_MODE_CUSTOM. With other docking modes modify the insets of this overlay and/or layout of the contents View and call size_to_preferred_size() instead to calculate the new size and re-position the overlay if necessary.

| `function GetSize: TCefSize;`
Returns the size of this overlay in parent coordinates.

| `procedure SetPosition(const position: TCefPoint);`
Sets the position of this overlay without changing the size. |position| is in parent coordinates and any insets configured on this overlay will be ignored. Use this function only for overlays created with a docking mode value of CEF_DOCKING_MODE_CUSTOM. With other docking modes modify the insets of this overlay and/or layout of the contents View and call size_to_preferred_size() instead to calculate the new size and re-position the overlay if necessary.

| `function GetPosition: TCefPoint;`
Returns the position of this overlay in parent coordinates.

| `procedure SetInsets(const insets: TCefInsets);`
Sets the insets for this overlay. |insets| is in parent coordinates. Use this function only for overlays created with a docking mode value other than CEF_DOCKING_MODE_CUSTOM.

| `function GetInsets: TCefInsets;`
Returns the insets for this overlay in parent coordinates.

| `procedure SizeToPreferredSize;`
Size this overlay to its preferred size and trigger a re-layout if necessary. The position of overlays created with a docking mode value of CEF_DOCKING_MODE_CUSTOM will not be modified by calling this function. With other docking modes this function may re-position the overlay if necessary to accommodate the new size and any insets configured on the contents View.

| `procedure SetVisible(visible: boolean);`
Sets whether this overlay is visible. Overlays are hidden by default. If this overlay is 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.

| `function IsVisible: boolean;`
Returns whether this overlay is visible. A View may be visible but still not drawn in a Window if any parent Views are hidden. Call is_drawn() to determine whether this overlay and all parent Views are visible and will be drawn.

| `function IsDrawn: boolean;`
Returns whether this overlay is visible and drawn in a Window. A View is drawn if it and all parent Views are visible. To determine if the containing Window is visible to the user on-screen call is_visible() on the Window.

### Properties

| `property ContentsView : ICefView read GetContentsView;`
Returns the contents View for this overlay.

| `property Window : ICefWindow read GetWindow;`
Returns the top-level Window hosting this overlay. Use this function instead of calling get_window() on the contents View.

| `property DockingMode : TCefDockingMode read GetDockingMode;`
Returns the docking mode for this overlay.

| `property Bounds : TCefRect read GetBounds write SetBounds;`
Returns the bounds (size and position) of this overlay in parent coordinates.

| `property BoundsInScreen : TCefRect read GetBoundsInScreen;`
Returns the bounds (size and position) of this overlay in DIP screen coordinates.

| `property Size : TCefSize read GetSize write SetSize;`
Returns the size of this overlay in parent coordinates.

| `property Position : TCefPoint read GetPosition write SetPosition;`
Returns the position of this overlay in parent coordinates.

| `property Insets : TCefInsets read GetInsets write SetInsets;`
Returns the insets for this overlay in parent coordinates.

| `property Visible : boolean read IsVisible write SetVisible;`
Returns whether this overlay is visible. A View may be visible but still not drawn in a Window if any parent Views are hidden. Call is_drawn() to determine whether this overlay and all parent Views are visible and will be drawn.

| `property Drawn : boolean read IsDrawn;`
Returns whether this overlay is visible and drawn in a Window. A View is drawn if it and all parent Views are visible. To determine if the containing Window is visible to the user on-screen call is_visible() on the Window.

Generated by PasDoc 0.16.0-snapshot.