Struct WINDOWS_EXTENSIONS 

pub struct WINDOWS_EXTENSIONS;

Windows extensions hooks.

Implementations

impl WINDOWS_EXTENSIONS

pub fn register_root_extender( &self, extender: impl FnMut(WindowRootExtenderArgs) -> UiNode + Send + 'static, )

Register the closure extender to be called with the root of every new window starting on the next update.

The closure returns the new root node that will be passed to any other root extender until the actual final root node is created. The closure is called in the WINDOW context of the new window, so it can be used to modify the window context too.

This is an advanced API that enables app wide features, like themes, to inject context in every new window. The extender is called in the context of the window, after the window creation future has completed.

Note that the root node passed to the extender is the child node of the WindowRoot widget, not the widget itself. The extended root will be wrapped in the root widget node, that is, the final root widget will be root(extender_nodes(CONTEXT(EVENT(..)))), so extension nodes should operate as CONTEXT properties.

Note that for themes the zng-wgt-window crate provides a register_style_fn API that is built over this method and more oriented for theming.

pub fn register_open_nested_handler( &self, handler: impl FnMut(&mut OpenNestedHandlerArgs) + Send + 'static, )

Register the closure handler to be called for every new window starting on the next update.

The closure is called in the new WINDOW context and can optionally call OpenNestedHandlerArgs::nest to convert to a nested window. Nested windows can be manipulated using the WINDOWS API just like other windows, but are layout and rendered inside another window.

This is primarily an adapter for mobile platforms that only support one real window, it accelerates cross platform support from projects originally desktop only.

Note that this API is not recommended for implementing features such as window docking or tabbing, for that you probably need to model tabs as objects that can outlive their host windows and use ArcNode to transfer the content between host windows.

pub fn view_extensions_init( &self, window_id: impl Into<WindowId>, extension_id: ApiExtensionId, request: ApiExtensionPayload, ) -> Result<(), ViewExtensionError>

Add a view-process extension payload to the window request for the view-process.

This will only work if called on the first UiNode::init and at most the first UiNode::layout of the window.

The payload is dropped after it is send, this method must be called again on VIEW_PROCESS_INITED_EVENT to reinitialize the extensions after view-process respawn.

pub fn view_window_extension_raw( &self, window_id: impl Into<WindowId>, extension_id: ApiExtensionId, request: ApiExtensionPayload, ) -> Result<ApiExtensionPayload, ViewExtensionError>

Call a view-process headed window extension with custom encoded payload.

Note that unlike most service methods this calls happens immediately.

pub fn view_window_extension<I, O>( &self, window_id: impl Into<WindowId>, extension_id: ApiExtensionId, request: &I, ) -> Result<O, ViewExtensionError>

where I: Serialize, O: DeserializeOwned,

Call a headed window extension with serialized payload.

Note that unlike most service methods this call happens immediately.

pub fn view_render_extension_raw( &self, window_id: impl Into<WindowId>, extension_id: ApiExtensionId, request: ApiExtensionPayload, ) -> Result<ApiExtensionPayload, ViewExtensionError>

Call a view-process render extension with custom encoded payload for the renderer associated with the window.

Note that unlike most service methods this call happens immediately.

pub fn view_render_extension<I, O>( &self, window_id: impl Into<WindowId>, extension_id: ApiExtensionId, request: &I, ) -> Result<O, ViewExtensionError>

where I: Serialize, O: DeserializeOwned,

Call a render extension with serialized payload for the renderer associated with the window.

Note that unlike most service methods this call happens immediately.