Type Alias cef_overlay_controller_t 

pub type cef_overlay_controller_t = _cef_overlay_controller_t;

Controller for an overlay that contains a contents View added via cef_window_t::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.

NOTE: This struct is allocated DLL-side.

Aliased Type

#[repr(C)]
pub struct cef_overlay_controller_t {

    pub base: _cef_base_ref_counted_t,
    pub is_valid: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> i32>,
    pub is_same: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *mut _cef_overlay_controller_t) -> i32>,
    pub get_contents_view: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> *mut _cef_view_t>,
    pub get_window: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> *mut _cef_window_t>,
    pub get_docking_mode: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> cef_docking_mode_t>,
    pub destroy: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t)>,
    pub set_bounds: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_rect_t)>,
    pub get_bounds: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_rect_t>,
    pub get_bounds_in_screen: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_rect_t>,
    pub set_size: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_size_t)>,
    pub get_size: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_size_t>,
    pub set_position: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_point_t)>,
    pub get_position: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_point_t>,
    pub set_insets: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_insets_t)>,
    pub get_insets: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_insets_t>,
    pub size_to_preferred_size: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t)>,
    pub set_visible: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, i32)>,
    pub is_visible: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> i32>,
    pub is_drawn: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> i32>,
}

Fields

base: _cef_base_ref_counted_t

Base structure.

is_valid: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> i32>

Returns true (1) if this object is valid.

is_same: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *mut _cef_overlay_controller_t) -> i32>

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

get_contents_view: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> *mut _cef_view_t>

Returns the contents View for this overlay.

get_window: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> *mut _cef_window_t>

Returns the top-level Window hosting this overlay. Use this function instead of calling get_window() on the contents View.

get_docking_mode: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> cef_docking_mode_t>

Returns the docking mode for this overlay.

destroy: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t)>

Destroy this overlay.

set_bounds: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_rect_t)>

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.

get_bounds: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_rect_t>

Returns the bounds (size and position) of this overlay in parent coordinates.

get_bounds_in_screen: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_rect_t>

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

set_size: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_size_t)>

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.

get_size: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_size_t>

Returns the size of this overlay in parent coordinates.

set_position: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_point_t)>

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.

get_position: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_point_t>

Returns the position of this overlay in parent coordinates.

set_insets: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, *const _cef_insets_t)>

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.

get_insets: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> _cef_insets_t>

Returns the insets for this overlay in parent coordinates.

size_to_preferred_size: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t)>

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.

set_visible: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t, i32)>

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.

is_visible: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> i32>

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.

is_drawn: Option<unsafe extern "C" fn(*mut _cef_overlay_controller_t) -> i32>

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.