Struct _cef_window_t 

#[repr(C)]
pub struct _cef_window_t {

    pub base: cef_panel_t,
    pub show: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub show_as_browser_modal_dialog: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, browser_view: *mut _cef_browser_view_t)>,
    pub hide: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub center_window: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, size: *const cef_size_t)>,
    pub close: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub is_closed: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>,
    pub activate: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub deactivate: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub is_active: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>,
    pub bring_to_top: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub set_always_on_top: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, on_top: c_int)>,
    pub is_always_on_top: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>,
    pub maximize: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub minimize: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub restore: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub set_fullscreen: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, fullscreen: c_int)>,
    pub is_maximized: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>,
    pub is_minimized: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>,
    pub is_fullscreen: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>,
    pub get_focused_view: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_view_t>,
    pub set_title: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, title: *const cef_string_t)>,
    pub get_title: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_string_userfree_t>,
    pub set_window_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, image: *mut _cef_image_t)>,
    pub get_window_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_image_t>,
    pub set_window_app_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, image: *mut _cef_image_t)>,
    pub get_window_app_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_image_t>,
    pub add_overlay_view: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, view: *mut _cef_view_t, docking_mode: cef_docking_mode_t, can_activate: c_int) -> *mut _cef_overlay_controller_t>,
    pub show_menu: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, menu_model: *mut _cef_menu_model_t, screen_point: *const cef_point_t, anchor_position: cef_menu_anchor_position_t)>,
    pub cancel_menu: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub get_display: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_display_t>,
    pub get_client_area_bounds_in_screen: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_rect_t>,
    pub set_draggable_regions: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, regionsCount: usize, regions: *const cef_draggable_region_t)>,
    pub get_window_handle: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_window_handle_t>,
    pub send_key_press: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, key_code: c_int, event_flags: u32)>,
    pub send_mouse_move: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, screen_x: c_int, screen_y: c_int)>,
    pub send_mouse_events: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, button: cef_mouse_button_type_t, mouse_down: c_int, mouse_up: c_int)>,
    pub set_accelerator: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, command_id: c_int, key_code: c_int, shift_pressed: c_int, ctrl_pressed: c_int, alt_pressed: c_int, high_priority: c_int)>,
    pub remove_accelerator: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, command_id: c_int)>,
    pub remove_all_accelerators: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub set_theme_color: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, color_id: c_int, color: cef_color_t)>,
    pub theme_changed: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>,
    pub get_runtime_style: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_runtime_style_t>,
}

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.

NOTE: This struct is allocated DLL-side.

Fields

base: cef_panel_t

Base structure.

show: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Show the Window.

show_as_browser_modal_dialog: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, browser_view: *mut _cef_browser_view_t)>

Show the Window as a browser modal dialog relative to |browser_view|. A parent Window must be returned via cef_window_delegate_t::get_parent_window() 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 cef_window_delegate_t::is_window_modal_dialog() for a window modal dialog where all controls in the parent Window are disabled.

hide: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Hide the Window.

center_window: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, size: *const cef_size_t)>

Sizes the Window to |size| and centers it in the current display.

close: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Close the Window.

is_closed: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>

Returns true (1) if the Window has been closed.

activate: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

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

deactivate: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Deactivate the Window, making the next Window in the Z order the active Window.

is_active: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>

Returns whether the Window is the currently active Window.

bring_to_top: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Bring this Window to the top of other Windows in the Windowing system.

set_always_on_top: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, on_top: c_int)>

Set the Window to be on top of other Windows in the Windowing system.

is_always_on_top: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>

Returns whether the Window has been set to be on top of other Windows in the Windowing system.

maximize: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Maximize the Window.

minimize: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Minimize the Window.

restore: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Restore the Window.

set_fullscreen: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, fullscreen: c_int)>

Set fullscreen Window state. The cef_window_delegate_t::OnWindowFullscreenTransition function will be called during the fullscreen transition for notification purposes.

is_maximized: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>

Returns true (1) if the Window is maximized.

is_minimized: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>

Returns true (1) if the Window is minimized.

is_fullscreen: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> c_int>

Returns true (1) if the Window is fullscreen.

get_focused_view: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_view_t>

Returns the View that currently has focus in this Window, or nullptr if no View currently has focus. A Window may have a focused View even if it is not currently active. Any focus changes while a Window is not active may be applied after that Window next becomes active.

set_title: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, title: *const cef_string_t)>

Set the Window title.

get_title: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_string_userfree_t>

Get the Window title.

set_window_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, image: *mut _cef_image_t)>

Set the Window icon. This should be a 16x16 icon suitable for use in the Windows’s title bar.

get_window_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_image_t>

Get the Window icon.

set_window_app_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, image: *mut _cef_image_t)>

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.

get_window_app_icon: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_image_t>

Get the Window App icon.

add_overlay_view: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, view: *mut _cef_view_t, docking_mode: cef_docking_mode_t, can_activate: c_int) -> *mut _cef_overlay_controller_t>

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 CefOverlayController::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 CefOverlayController::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.

show_menu: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, menu_model: *mut _cef_menu_model_t, screen_point: *const cef_point_t, anchor_position: cef_menu_anchor_position_t)>

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

cancel_menu: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Cancel the menu that is currently showing, if any.

get_display: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> *mut _cef_display_t>

Returns the Display that most closely intersects the bounds of this Window. May return NULL if this Window is not currently displayed.

get_client_area_bounds_in_screen: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_rect_t>

Returns the bounds (size and position) of this Window’s client area. Position is in screen coordinates.

set_draggable_regions: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, regionsCount: usize, regions: *const cef_draggable_region_t)>

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.

get_window_handle: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_window_handle_t>

Retrieve the platform window handle for this Window.

send_key_press: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, key_code: c_int, event_flags: u32)>

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.

send_mouse_move: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, screen_x: c_int, screen_y: c_int)>

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.

send_mouse_events: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, button: cef_mouse_button_type_t, mouse_down: c_int, mouse_up: c_int)>

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.

set_accelerator: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, command_id: c_int, key_code: c_int, shift_pressed: c_int, ctrl_pressed: c_int, alt_pressed: c_int, high_priority: c_int)>

Set the keyboard accelerator for the specified |command_id|. |key_code| can be any virtual key or character value. Required modifier keys are specified by |shift_pressed|, |ctrl_pressed| and/or |alt_pressed|. cef_window_delegate_t::OnAccelerator will be called if the keyboard combination is triggered while this window has focus.

The |high_priority| value will be considered if a child cef_browser_view_t 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 cef_keyboard_handler_t first. If |high_priority| is false (0) then the behavior will depend on the cef_browser_view_t::SetPreferAccelerators configuration.

remove_accelerator: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, command_id: c_int)>

Remove the keyboard accelerator for the specified |command_id|.

remove_all_accelerators: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Remove all keyboard accelerators.

set_theme_color: Option<unsafe extern "C" fn(self_: *mut _cef_window_t, color_id: c_int, color: cef_color_t)>

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 CefWindow::ThemeChanged to trigger CefViewDelegate::OnThemeChanged notifications.
2. Customize the current native/OS or Chrome theme after it changes by calling SetThemeColor from the CefWindowDelegate::OnThemeColorsChanged callback. CefViewDelegate::OnThemeChanged notifications will then be triggered automatically.

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

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

theme_changed: Option<unsafe extern "C" fn(self_: *mut _cef_window_t)>

Trigger cef_view_delegate_t::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 cef_window_delegate_t::OnThemeColorsChanged.

Do not call this function from cef_window_delegate_t::OnThemeColorsChanged or cef_view_delegate_t::OnThemeChanged.

get_runtime_style: Option<unsafe extern "C" fn(self_: *mut _cef_window_t) -> cef_runtime_style_t>

Returns the runtime style for this Window (ALLOY or CHROME). See cef_runtime_style_t documentation for details.

Trait Implementations

impl Clone for _cef_window_t

fn clone(&self) -> _cef_window_t

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for _cef_window_t

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for _cef_window_t