Interface ICefWindow

Description

Hierarchy

Fields

Methods

Properties

Unit

uCEFInterfaces

Declaration

type ICefWindow = interface(ICefPanel)

Description

A Window is a top-level Window/widget in the Views hierarchy. By default it will have a non-client area with title bar, icon and buttons that supports moving and resizing. All size and position values are in density independent pixels (DIP) 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_window_capi.h">CEF source file: /include/capi/views/cef_window_capi.h (cef_window_t))

Hierarchy

IInterface
ICefBaseRefCounted
ICefView
ICefPanel
ICefWindow

Overview

Methods

	`procedure Show;`
	`procedure ShowAsBrowserModalDialog(const browser_view: ICefBrowserView);`
	`procedure Hide;`
	`procedure CenterWindow(const size_: TCefSize);`
	`procedure Close;`
	`function IsClosed: boolean;`
	`procedure Activate;`
	`procedure Deactivate;`
	`function IsActive: boolean;`
	`procedure BringToTop;`
	`procedure SetAlwaysOnTop(on_top: boolean);`
	`function IsAlwaysOnTop: boolean;`
	`procedure Maximize;`
	`procedure Minimize;`
	`procedure Restore;`
	`procedure SetFullscreen(fullscreen: boolean);`
	`function IsMaximized: boolean;`
	`function IsMinimized: boolean;`
	`function IsFullscreen: boolean;`
	`procedure SetTitle(const title_: ustring);`
	`function GetTitle: ustring;`
	`procedure SetWindowIcon(const image: ICefImage);`
	`function GetWindowIcon: ICefImage;`
	`procedure SetWindowAppIcon(const image: ICefImage);`
	`function GetWindowAppIcon: ICefImage;`
	`function AddOverlayView(const view: ICefView; docking_mode: TCefDockingMode; can_activate: boolean): ICefOverlayController;`
	`procedure ShowMenu(const menu_model: ICefMenuModel; const screen_point: TCefPoint; anchor_position : TCefMenuAnchorPosition);`
	`procedure CancelMenu;`
	`function GetDisplay: ICefDisplay;`
	`function GetClientAreaBoundsInScreen: TCefRect;`
	`procedure SetDraggableRegions(regionsCount: NativeUInt; const regions: PCefDraggableRegionArray);`
	`function GetWindowHandle: TCefWindowHandle;`
	`procedure SendKeyPress(key_code: Integer; event_flags: cardinal);`
	`procedure SendMouseMove(screen_x, screen_y: Integer);`
	`procedure SendMouseEvents(button: TCefMouseButtonType; mouse_down, mouse_up: boolean);`
	`procedure SetAccelerator(command_id, key_code : Integer; shift_pressed, ctrl_pressed, alt_pressed, high_priority: boolean);`
	`procedure RemoveAccelerator(command_id: Integer);`
	`procedure RemoveAllAccelerators;`
	`procedure SetThemeColor(color_id: integer; color: TCefColor);`
	`procedure ThemeChanged;`
	`function GetRuntimeStyle: TCefRuntimeStyle;`

Properties

	`property Title : ustring read GetTitle write SetTitle;`
	`property WindowIcon : ICefImage read GetWindowIcon write SetWindowIcon;`
	`property WindowAppIcon : ICefImage read GetWindowAppIcon write SetWindowAppIcon;`
	`property Display : ICefDisplay read GetDisplay;`
	`property ClientAreaBoundsInScreen : TCefRect read GetClientAreaBoundsInScreen;`
	`property WindowHandle : TCefWindowHandle read GetWindowHandle;`
	`property RuntimeStyle : TCefRuntimeStyle read GetRuntimeStyle;`

Description

Methods

procedure Show;

Show the Window.

Attributes

GUID['{C450C974-BF0A-4968-A6BE-153CEAD10DA6}']

procedure ShowAsBrowserModalDialog(const browser_view: ICefBrowserView);

Show the Window as a browser modal dialog relative to |browser_view|. A parent Window must be returned via ICefWindowDelegate.GetParentWindow() and |browser_view| must belong to that parent Window. While this Window is visible, |browser_view| will be disabled while other controls in the parent Window remain enabled. Navigating or destroying the |browser_view| will close this Window automatically. Alternately, use show() and return true (1) from ICefWindowDelegate.IsWindowModalDialog() for a window modal dialog where all controls in the parent Window are disabled.

	`procedure Hide;`
Hide the Window.

	`procedure CenterWindow(const size_: TCefSize);`
Sizes the Window to \|size\| and centers it in the current display.

	`procedure Close;`
Close the Window.

	`function IsClosed: boolean;`
Returns true (1) if the Window has been closed.

	`procedure Activate;`
Activate the Window, assuming it already exists and is visible.

	`procedure Deactivate;`
Deactivate the Window, making the next Window in the Z order the active Window.

	`function IsActive: boolean;`
Returns whether the Window is the currently active Window.

	`procedure BringToTop;`
Bring this Window to the top of other Windows in the Windowing system.

	`procedure SetAlwaysOnTop(on_top: boolean);`
Set the Window to be on top of other Windows in the Windowing system.

	`function IsAlwaysOnTop: boolean;`
Returns whether the Window has been set to be on top of other Windows in the Windowing system.

	`procedure Maximize;`
Maximize the Window.

	`procedure Minimize;`
Minimize the Window.

	`procedure Restore;`
Restore the Window.

	`procedure SetFullscreen(fullscreen: boolean);`
Set fullscreen Window state. The ICefWindowDelegate.OnWindowFullscreenTransition function will be called during the fullscreen transition for notification purposes.

	`function IsMaximized: boolean;`
Returns true (1) if the Window is maximized.

	`function IsMinimized: boolean;`
Returns true (1) if the Window is minimized.

	`function IsFullscreen: boolean;`
Returns true (1) if the Window is fullscreen.

	`procedure SetTitle(const title_: ustring);`
Set the Window title.

	`function GetTitle: ustring;`
Get the Window title.

	`procedure SetWindowIcon(const image: ICefImage);`
Set the Window icon. This should be a 16x16 icon suitable for use in the Windows's title bar.

	`function GetWindowIcon: ICefImage;`
Get the Window icon.

	`procedure SetWindowAppIcon(const image: ICefImage);`
Set the Window App icon. This should be a larger icon for use in the host environment app switching UI. On Windows, this is the ICON_BIG used in Alt-Tab list and Windows taskbar. The Window icon will be used by default if no Window App icon is specified.

	`function GetWindowAppIcon: ICefImage;`
Get the Window App icon.

function AddOverlayView(const view: ICefView; docking_mode: TCefDockingMode; can_activate: boolean): ICefOverlayController;

Add a View that will be overlayed on the Window contents with absolute positioning and high z-order. Positioning is controlled by |docking_mode| as described below. Setting |can_activate| to true (1) will allow the overlay view to receive input focus. The returned cef_overlay_controller_t object is used to control the overlay. Overlays are hidden by default.

With CEF_DOCKING_MODE_CUSTOM: 1. The overlay is initially hidden, sized to |view|'s preferred size, and positioned in the top-left corner. 2. Optionally change the overlay position and/or size by calling CefOverlayController methods. 3. Call ICefOverlayController.SetVisible(true) to show the overlay. 4. The overlay will be automatically re-sized if |view|'s layout changes. Optionally change the overlay position and/or size when OnLayoutChanged is called on the Window's delegate to indicate a change in Window bounds.

With other docking modes: 1. The overlay is initially hidden, sized to |view|'s preferred size, and positioned based on |docking_mode|. 2. Call ICefOverlayController.SetVisible(true) to show the overlay. 3. The overlay will be automatically re-sized if |view|'s layout changes and re-positioned as appropriate when the Window resizes.

Overlays created by this function will receive a higher z-order then any child Views added previously. It is therefore recommended to call this function last after all other child Views have been added so that the overlay displays as the top-most child of the Window.

	`procedure ShowMenu(const menu_model: ICefMenuModel; const screen_point: TCefPoint; anchor_position : TCefMenuAnchorPosition);`
Show a menu with contents \|menu_model\|. \|screen_point\| specifies the menu position in screen coordinates. \|anchor_position\| specifies how the menu will be anchored relative to \|screen_point\|.

	`procedure CancelMenu;`
Cancel the menu that is currently showing, if any.

	`function GetDisplay: ICefDisplay;`
Returns the Display that most closely intersects the bounds of this Window. May return NULL if this Window is not currently displayed.

	`function GetClientAreaBoundsInScreen: TCefRect;`
Returns the bounds (size and position) of this Window's client area. Position is in screen coordinates.

	`procedure SetDraggableRegions(regionsCount: NativeUInt; const regions: PCefDraggableRegionArray);`
Set the regions where mouse events will be intercepted by this Window to support drag operations. Call this function with an NULL vector to clear the draggable regions. The draggable region bounds should be in window coordinates.

	`function GetWindowHandle: TCefWindowHandle;`
Retrieve the platform window handle for this Window.

	`procedure SendKeyPress(key_code: Integer; event_flags: cardinal);`
Simulate a key press. \|key_code\| is the VKEY_* value from Chromium's ui/events/keycodes/keyboard_codes.h header (VK_* values on Windows). \|event_flags\| is some combination of EVENTFLAG_SHIFT_DOWN, EVENTFLAG_CONTROL_DOWN and/or EVENTFLAG_ALT_DOWN. This function is exposed primarily for testing purposes.

	`procedure SendMouseMove(screen_x, screen_y: Integer);`
Simulate a mouse move. The mouse cursor will be moved to the specified (screen_x, screen_y) position. This function is exposed primarily for testing purposes.

procedure SendMouseEvents(button: TCefMouseButtonType; mouse_down, mouse_up: boolean);

Simulate mouse down and/or mouse up events. |button| is the mouse button type. If |mouse_down| is true (1) a mouse down event will be sent. If |mouse_up| is true (1) a mouse up event will be sent. If both are true (1) a mouse down event will be sent followed by a mouse up event (equivalent to clicking the mouse button). The events will be sent using the current cursor position so make sure to call send_mouse_move() first to position the mouse. This function is exposed primarily for testing purposes.

procedure SetAccelerator(command_id, key_code : Integer; shift_pressed, ctrl_pressed, alt_pressed, high_priority: boolean);

The |high_priority| value will be considered if a child ICefBrowserView has focus when the keyboard combination is triggered. If |high_priority| is true (1) then the key event will not be forwarded to the web content (`keydown` event handler) or ICefKeyboardHandler first. If |high_priority| is false (0) then the behavior will depend on the ICefBrowserView.SetPreferAccelerators configuration.

	`procedure RemoveAccelerator(command_id: Integer);`
Remove the keyboard accelerator for the specified \|command_id\|.

	`procedure RemoveAllAccelerators;`
Remove all keyboard accelerators.

procedure SetThemeColor(color_id: integer; color: TCefColor);

Override a standard theme color or add a custom color associated with |color_id|. See cef_color_ids.h for standard ID values. Recommended usage is as follows:

1. Customize the default native/OS theme by calling SetThemeColor before
   showing the first Window. When done setting colors call
   ICefWindow.ThemeChanged to trigger ICefViewDelegate.OnThemeChanged
   notifications.
2. Customize the current native/OS or Chrome theme after it changes by
   calling SetThemeColor from the ICefWindowDelegate.OnThemeColorsChanged
   callback. ICefViewDelegate.OnThemeChanged notifications will then be
   triggered automatically.

The configured color will be available immediately via ICefView.GetThemeColor and will be applied to each View in this Window's component hierarchy when ICefViewDelegate.OnThemeChanged is called. See OnThemeColorsChanged documentation for additional details.

Clients wishing to add custom colors should use |color_id| values >= CEF_ChromeColorsEnd.

procedure ThemeChanged;

Trigger ICefViewDelegate.OnThemeChanged callbacks for each View in this Window's component hierarchy. Unlike a native/OS or Chrome theme change this function does not reset theme colors to standard values and does not result in a call to ICefWindowDelegate.OnThemeColorsChanged.

Do not call this function from ICefWindowDelegate.OnThemeColorsChanged or ICefViewDelegate.OnThemeChanged.

	`function GetRuntimeStyle: TCefRuntimeStyle;`
Returns the runtime style for this Window (ALLOY or CHROME). See TCefRuntimeStyle documentation for details.

Properties

	`property Title : ustring read GetTitle write SetTitle;`
Get the Window title.

	`property WindowIcon : ICefImage read GetWindowIcon write SetWindowIcon;`
Get the Window icon.

	`property WindowAppIcon : ICefImage read GetWindowAppIcon write SetWindowAppIcon;`
Get the Window App icon.

	`property Display : ICefDisplay read GetDisplay;`
Returns the Display that most closely intersects the bounds of this Window. May return NULL if this Window is not currently displayed.

	`property ClientAreaBoundsInScreen : TCefRect read GetClientAreaBoundsInScreen;`
Returns the bounds (size and position) of this Window's client area. Position is in screen coordinates.

	`property WindowHandle : TCefWindowHandle read GetWindowHandle;`
Retrieve the platform window handle for this Window.

	`property RuntimeStyle : TCefRuntimeStyle read GetRuntimeStyle;`
Returns the runtime style for this Window (ALLOY or CHROME). See TCefRuntimeStyle documentation for details.

Generated by PasDoc 0.16.0-snapshot.