Struct MiniFrameIsOwned

pub struct MiniFrameIsOwned<const OWNED: bool>(/* private fields */);

A miniframe is a frame with a small title bar.

• MiniFrame represents a C++ wxMiniFrame class instance which your code has ownership, MiniFrameIsOwned<false> represents one which don’t own.
• Use MiniFrame’s new() or Buildable::builder() (if available) to create an instance of this class.
• See C++ wxMiniFrame class’s documentation for more details.

Implementations

impl<const OWNED: bool> MiniFrameIsOwned<OWNED>

pub fn new_2step() -> MiniFrameIsOwned<OWNED>

Default ctor.

See C++ wxMiniFrame::wxMiniFrame()’s documentation.

pub fn new<W: WindowMethods, P: PointMethods, S: SizeMethods>( parent: Option<&W>, id: c_int, title: &str, pos: &P, size: &S, style: c_long, name: &str, ) -> MiniFrameIsOwned<OWNED>

Constructor, creating the window.

See C++ wxMiniFrame::wxMiniFrame()’s documentation.

pub fn none() -> Option<&'static Self>

Trait Implementations

impl<const OWNED: bool> Clone for MiniFrameIsOwned<OWNED>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const OWNED: bool> DynamicCast for MiniFrameIsOwned<OWNED>

fn class_info() -> ClassInfoIsOwned<false>

fn as_unowned<T>(&self) -> Option<<T as WxRustMethods>::Unowned>

where T: DynamicCast,

impl<const OWNED: bool> EvtHandlerMethods for MiniFrameIsOwned<OWNED>

fn queue_event<E>(&self, event: Option<&E>)

where E: EventMethods,

Queue event for a later processing.

fn add_pending_event<E>(&self, event: &E)

where E: EventMethods,

Post an event to be processed later.

fn process_event<E>(&self, event: &E) -> bool

where E: EventMethods,

Processes an event, searching event tables and calling zero or more suitable event handler function(s).

fn process_event_locally<E>(&self, event: &E) -> bool

where E: EventMethods,

Try to process the event in this handler and all those chained to it.

fn safely_process_event<E>(&self, event: &E) -> bool

where E: EventMethods,

Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process.

fn process_pending_events(&self)

Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail.

fn delete_pending_events(&self)

Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent().

fn get_client_object(&self) -> Option<ClientDataIsOwned<false>>

Returns a pointer to the user-supplied client data object.

fn set_client_object<C>(&self, data: Option<&C>)

where C: ClientDataMethods,

Set the client data object.

fn get_evt_handler_enabled(&self) -> bool

Returns true if the event handler is enabled, false otherwise.

fn get_next_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>

Returns the pointer to the next handler in the chain.

fn get_previous_handler(&self) -> WeakRef<EvtHandlerIsOwned<true>>

Returns the pointer to the previous handler in the chain.

fn set_evt_handler_enabled(&self, enabled: bool)

Enables or disables the event handler.

fn set_next_handler<E>(&self, handler: Option<&E>)

where E: EvtHandlerMethods,

Sets the pointer to the next handler.

fn set_previous_handler<E>(&self, handler: Option<&E>)

where E: EvtHandlerMethods,

Sets the pointer to the previous handler.

fn unlink(&self)

Unlinks this event handler from the chain it’s part of (if any); then links the “previous” event handler to the “next” one (so that the chain won’t be interrupted).

fn is_unlinked(&self) -> bool

Returns true if the next and the previous handler pointers of this event handler instance are NULL.

fn add_filter(filter: *mut c_void)

Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets.

fn remove_filter(filter: *mut c_void)

Remove a filter previously installed with AddFilter().

impl<const OWNED: bool> FrameMethods for MiniFrameIsOwned<OWNED>

fn create_status_bar( &self, number: c_int, style: c_long, id: c_int, name: &str, ) -> WeakRef<StatusBar>

Creates a status bar at the bottom of the frame.

fn create_tool_bar( &self, style: c_long, id: c_int, name: &str, ) -> WeakRef<ToolBar>

Creates a toolbar at the top or left of the frame.

fn do_give_help(&self, text: &str, show: bool)

Method used to show help string of the selected menu toolbar item.

fn get_menu_bar(&self) -> WeakRef<MenuBar>

Returns a pointer to the menubar currently associated with the frame (if any).

fn get_status_bar(&self) -> WeakRef<StatusBar>

Returns a pointer to the status bar currently associated with the frame (if any).

fn get_status_bar_pane(&self) -> c_int

Returns the status bar pane used to display menu and toolbar help.

fn get_tool_bar(&self) -> WeakRef<ToolBar>

Returns a pointer to the toolbar currently associated with the frame (if any).

fn on_create_status_bar( &self, number: c_int, style: c_long, id: c_int, name: &str, ) -> WeakRef<StatusBar>

Virtual function called when a status bar is requested by CreateStatusBar().

fn on_create_tool_bar( &self, style: c_long, id: c_int, name: &str, ) -> WeakRef<ToolBar>

Virtual function called when a toolbar is requested by CreateToolBar().

fn process_command(&self, id: c_int) -> bool

Simulate a menu command.

fn set_menu_bar<M: MenuBarMethods>(&self, menu_bar: Option<&M>)

Tells the frame to show the given menu bar.

fn set_status_bar<S: StatusBarMethods>(&self, status_bar: Option<&S>)

Associates a status bar with the frame.

fn set_status_bar_pane(&self, n: c_int)

Set the status bar pane used to display menu and toolbar help.

fn set_status_text(&self, text: &str, number: c_int)

Sets the status bar text and updates the status bar display.

fn set_status_widths(&self, n: c_int, widths_field: *const c_void)

Sets the widths of the fields in the status bar.

fn set_tool_bar<T: ToolBarMethods>(&self, tool_bar: Option<&T>)

Associates a toolbar with the frame.

fn msw_get_task_bar_button(&self) -> *mut c_void

MSW-specific function for accessing the taskbar button under Windows 7 or later.

fn push_status_text(&self, text: &str, number: c_int)

See C++ wxFrame::PushStatusText()’s documentation.

fn pop_status_text(&self, number: c_int)

See C++ wxFrame::PopStatusText()’s documentation.

impl<const OWNED: bool> From<MiniFrameIsOwned<OWNED>> for EvtHandlerIsOwned<OWNED>

fn from(o: MiniFrameIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MiniFrameIsOwned<OWNED>> for FrameIsOwned<OWNED>

fn from(o: MiniFrameIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MiniFrameIsOwned<OWNED>> for NonOwnedWindowIsOwned<OWNED>

fn from(o: MiniFrameIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MiniFrameIsOwned<OWNED>> for ObjectIsOwned<OWNED>

fn from(o: MiniFrameIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MiniFrameIsOwned<OWNED>> for TopLevelWindowIsOwned<OWNED>

fn from(o: MiniFrameIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> From<MiniFrameIsOwned<OWNED>> for WindowIsOwned<OWNED>

fn from(o: MiniFrameIsOwned<OWNED>) -> Self

Converts to this type from the input type.

impl<const OWNED: bool> NonOwnedWindowMethods for MiniFrameIsOwned<OWNED>

fn set_shape_region<R: RegionMethods>(&self, region: &R) -> bool

If the platform supports it, sets the shape of the window to that depicted by region.

fn set_shape_graphicspath<G: GraphicsPathMethods>(&self, path: &G) -> bool

Set the window shape to the given path.

impl<const OWNED: bool> ObjectMethods for MiniFrameIsOwned<OWNED>

fn get_class_info(&self) -> Option<ClassInfoIsOwned<false>>

This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).

fn get_ref_data(&self) -> Option<ObjectRefDataIsOwned<false>>

Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.

fn is_kind_of<C>(&self, info: Option<&C>) -> bool

where C: ClassInfoMethods,

Determines whether this class is a subclass of (or the same class as) the given class.

fn is_same_as<O>(&self, obj: &O) -> bool

where O: ObjectMethods,

Returns true if this object has the same data pointer as obj.

fn ref_<O>(&self, clone: &O)

where O: ObjectMethods,

Makes this object refer to the data in clone.

fn set_ref_data<O>(&self, data: Option<&O>)

where O: ObjectRefDataMethods,

Sets the wxObject::m_refData pointer.

fn un_ref(&self)

Decrements the reference count in the associated data, and if it is zero, deletes the data.

fn un_share(&self)

This is the same of AllocExclusive() but this method is public.

impl<const OWNED: bool> TopLevelWindowMethods for MiniFrameIsOwned<OWNED>

fn create_str<W: WindowMethods, P: PointMethods, S: SizeMethods>( &self, parent: Option<&W>, id: c_int, title: &str, pos: &P, size: &S, style: c_long, name: &str, ) -> bool

Used in two-step frame construction.

See C++ wxMiniFrame::Create()’s documentation.

fn center_on_screen(&self, direction: c_int)

A synonym for CentreOnScreen().

fn centre_on_screen(&self, direction: c_int)

Centres the window on screen.

fn enable_close_button(&self, enable: bool) -> bool

Enables or disables the Close button (most often in the right upper corner of a dialog) and the Close entry of the system menu (most often in the left upper corner of the dialog).

fn enable_maximize_button(&self, enable: bool) -> bool

Enables or disables the Maximize button (in the right or left upper corner of a frame or dialog).

fn enable_minimize_button(&self, enable: bool) -> bool

Enables or disables the Minimize button (in the right or left upper corner of a frame or dialog).

fn get_default_item(&self) -> WeakRef<Window>

Returns a pointer to the button which is the default for this window, or NULL.

fn get_icon(&self) -> Icon

Returns the standard icon of the window.

fn get_title(&self) -> String

Gets a string containing the window title.

fn iconize(&self, iconize: bool)

Iconizes or restores the window.

fn is_active(&self) -> bool

Returns true if this window is currently active, i.e. if the user is currently working with it.

fn is_always_maximized(&self) -> bool

Returns true if this window is expected to be always maximized, either due to platform policy or due to local policy regarding particular class.

fn is_full_screen(&self) -> bool

Returns true if the window is in fullscreen mode.

fn is_iconized(&self) -> bool

Returns true if the window is iconized.

fn is_maximized(&self) -> bool

Returns true if the window is maximized.

fn maximize(&self, maximize: bool)

Maximizes or restores the window.

fn msw_get_system_menu(&self) -> WeakRef<Menu>

MSW-specific function for accessing the system menu.

fn request_user_attention(&self, flags: c_int)

Use a system-dependent way to attract users attention to the window when it is in background.

fn restore(&self)

Restore a previously iconized or maximized window to its normal state.

fn set_default_item<W: WindowMethods>(&self, win: Option<&W>) -> WeakRef<Window>

Changes the default item for the panel, usually win is a button.

fn set_tmp_default_item<W: WindowMethods>( &self, win: Option<&W>, ) -> WeakRef<Window>

See C++ wxTopLevelWindow::SetTmpDefaultItem()’s documentation.

fn get_tmp_default_item(&self) -> WeakRef<Window>

See C++ wxTopLevelWindow::GetTmpDefaultItem()’s documentation.

fn set_icon<I: IconMethods>(&self, icon: &I)

Sets the icon for this window.

fn set_icons<I: IconBundleMethods>(&self, icons: &I)

Sets several icons of different sizes for this window: this allows using different icons for different situations (e.g.

fn set_title(&self, title: &str)

Sets the window title.

fn should_prevent_app_exit(&self) -> bool

This virtual function is not meant to be called directly but can be overridden to return false (it returns true by default) to allow the application to close even if this, presumably not very important, window is still opened.

fn osx_set_modified(&self, modified: bool)

This function sets the wxTopLevelWindow’s modified state on macOS, which currently draws a black dot in the wxTopLevelWindow’s close button.

fn osx_is_modified(&self) -> bool

Returns the current modified state of the wxTopLevelWindow on macOS.

fn set_represented_filename(&self, filename: &str)

Sets the file name represented by this wxTopLevelWindow.

fn show_without_activating(&self)

Show the wxTopLevelWindow, but do not give it keyboard focus.

fn enable_full_screen_view(&self, enable: bool, style: c_long) -> bool

Enables the zoom button to toggle full screen mode.

fn show_full_screen(&self, show: bool, style: c_long) -> bool

Depending on the value of show parameter the window is either shown full screen or restored to its normal state.

fn get_default_size() -> Size

Get the default size for a new top level window.

impl<const OWNED: bool> WindowMethods for MiniFrameIsOwned<OWNED>

fn accepts_focus(&self) -> bool

This method may be overridden in the derived classes to return false to indicate that this control doesn’t accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn’t need focus.

fn accepts_focus_from_keyboard(&self) -> bool

This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn’t be included in the TAB traversal chain when using the keyboard.

fn accepts_focus_recursively(&self) -> bool

Overridden to indicate whether this window or one of its children accepts focus.

fn disable_focus_from_keyboard(&self)

Disable giving focus to this window using the keyboard navigation keys.

fn is_focusable(&self) -> bool

Can this window itself have focus?

fn can_accept_focus(&self) -> bool

Can this window have focus right now?

fn can_accept_focus_from_keyboard(&self) -> bool

Can this window be assigned focus from keyboard right now?

fn has_focus(&self) -> bool

Returns true if the window (or in case of composite controls, its main child window) has focus.

fn set_can_focus(&self, can_focus: bool)

This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).

fn enable_visible_focus(&self, enable: bool)

Enables or disables visible indication of keyboard focus.

fn set_focus(&self)

This sets the window to receive keyboard input.

fn set_focus_from_kbd(&self)

This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. using TAB key).

fn add_child<W: WindowMethods>(&self, child: Option<&W>)

Adds a child window.

fn destroy_children(&self) -> bool

Destroys all children of a window.

fn find_window_long(&self, id: c_long) -> WeakRef<Window>

Find a child of this window, by id.

fn find_window_str(&self, name: &str) -> WeakRef<Window>

Find a child of this window, by name.

fn get_children(&self) -> WindowListIsOwned<false>

Returns a const reference to the list of the window’s children.

fn remove_child<W: WindowMethods>(&self, child: Option<&W>)

Removes a child window.

fn get_grand_parent(&self) -> WeakRef<Window>

Returns the grandparent of a window, or NULL if there isn’t one.

fn get_next_sibling(&self) -> WeakRef<Window>

Returns the next window after this one among the parent’s children or NULL if this window is the last child.

fn get_parent(&self) -> WeakRef<Window>

Returns the parent of the window, or NULL if there is no parent.

fn get_prev_sibling(&self) -> WeakRef<Window>

Returns the previous window before this one among the parent’s children or NULL if this window is the first child.

fn is_descendant<W: WindowMethods>(&self, win: Option<&W>) -> bool

Check if the specified window is a descendant of this one.

fn reparent<W: WindowMethods>(&self, new_parent: Option<&W>) -> bool

Reparents the window, i.e. the window will be removed from its current parent window (e.g.

fn always_show_scrollbars(&self, hflag: bool, vflag: bool)

Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling.

fn get_scroll_pos(&self, orientation: c_int) -> c_int

Returns the built-in scrollbar position.

fn get_scroll_range(&self, orientation: c_int) -> c_int

Returns the built-in scrollbar range.

fn get_scroll_thumb(&self, orientation: c_int) -> c_int

Returns the built-in scrollbar thumb size.

fn can_scroll(&self, orient: c_int) -> bool

Returns true if this window can have a scroll bar in this orientation.

fn has_scrollbar(&self, orient: c_int) -> bool

Returns true if this window currently has a scroll bar for this orientation.

fn is_scrollbar_always_shown(&self, orient: c_int) -> bool

Return whether a scrollbar is always shown.

fn scroll_lines(&self, lines: c_int) -> bool

Scrolls the window by the given number of lines down (if lines is positive) or up.

fn scroll_pages(&self, pages: c_int) -> bool

Scrolls the window by the given number of pages down (if pages is positive) or up.

fn scroll_window<R: RectMethods>(&self, dx: c_int, dy: c_int, rect: Option<&R>)

Physically scrolls the pixels in the window and move child windows accordingly.

fn line_up(&self) -> bool

Same as ScrollLines (-1).

fn line_down(&self) -> bool

Same as ScrollLines (1).

fn page_up(&self) -> bool

Same as ScrollPages (-1).

fn page_down(&self) -> bool

Same as ScrollPages (1).

fn set_scroll_pos(&self, orientation: c_int, pos: c_int, refresh: bool)

Sets the position of one of the built-in scrollbars.

fn set_scrollbar( &self, orientation: c_int, position: c_int, thumb_size: c_int, range: c_int, refresh: bool, )

Sets the scrollbar properties of a built-in scrollbar.

fn begin_repositioning_children(&self) -> bool

Prepare for changing positions of multiple child windows.

fn end_repositioning_children(&self)

Fix child window positions after setting all of them at once.

fn cache_best_size<S: SizeMethods>(&self, size: &S)

Sets the cached best size value.

fn client_to_window_size<S: SizeMethods>(&self, size: &S) -> Size

Converts client area size size to corresponding window size.

fn window_to_client_size<S: SizeMethods>(&self, size: &S) -> Size

Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size.

fn fit(&self)

Sizes the window to fit its best size.

fn fit_inside(&self)

Similar to Fit(), but sizes the interior (virtual) size of a window.

fn from_dip_size<S: SizeMethods>(&self, sz: &S) -> Size

Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.

fn from_dip_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_dip_int(&self, d: c_int) -> c_int

Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit.

fn to_dip_size<S: SizeMethods>(&self, sz: &S) -> Size

Convert pixel values of the current toolkit to DPI-independent pixel values.

fn to_dip_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_dip_int(&self, d: c_int) -> c_int

Convert pixel values of the current toolkit to DPI-independent pixel values.

fn from_phys_size<S: SizeMethods>(&self, sz: &S) -> Size

Convert from physical pixels to logical pixels.

fn from_phys_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_phys_int(&self, d: c_int) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_phys_size<S: SizeMethods>(&self, sz: &S) -> Size

Convert from logical pixels to physical pixels.

fn to_phys_point<P: PointMethods>(&self, pt: &P) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_phys_int(&self, d: c_int) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn get_best_size(&self) -> Size

This functions returns the best acceptable minimal size for the window.

fn get_best_height(&self, width: c_int) -> c_int

Returns the best height needed by this window if it had the given width.

fn get_best_width(&self, height: c_int) -> c_int

Returns the best width needed by this window if it had the given height.

fn get_client_size_int(&self, width: *mut c_void, height: *mut c_void)

Returns the size of the window ‘client area’ in pixels.

fn get_client_size(&self) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn get_effective_min_size(&self) -> Size

Merges the window’s best size into the min size and returns the result.

fn get_max_client_size(&self) -> Size

Returns the maximum size of window’s client area.

fn get_max_size(&self) -> Size

Returns the maximum size of the window.

fn get_min_client_size(&self) -> Size

Returns the minimum size of window’s client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area.

fn get_min_size(&self) -> Size

Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size.

fn get_min_width(&self) -> c_int

Returns the horizontal component of window minimal size.

fn get_min_height(&self) -> c_int

Returns the vertical component of window minimal size.

fn get_max_width(&self) -> c_int

Returns the horizontal component of window maximal size.

fn get_max_height(&self) -> c_int

Returns the vertical component of window maximal size.

fn get_size_int(&self, width: *mut c_void, height: *mut c_void)

Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.

fn get_size(&self) -> Size

See the GetSize(int*,int*) overload for more info.

fn get_virtual_size(&self) -> Size

This gets the virtual size of the window in pixels.

fn get_virtual_size_int(&self, width: *mut c_void, height: *mut c_void)

Like the other GetVirtualSize() overload but uses pointers instead.

fn get_best_virtual_size(&self) -> Size

Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)

fn get_content_scale_factor(&self) -> c_double

Returns the factor mapping logical pixels of this window to physical pixels.

fn get_dpi_scale_factor(&self) -> c_double

Returns the ratio of the DPI used by this window to the standard DPI.

fn get_window_border_size(&self) -> Size

Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively.

fn inform_first_direction( &self, direction: c_int, size: c_int, available_other_dir: c_int, ) -> bool

wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known.

fn invalidate_best_size(&self)

Resets the cached best size value so it will be recalculated the next time it is needed.

fn post_size_event(&self)

Posts a size event to the window.

fn post_size_event_to_parent(&self)

Posts a size event to the parent of this window.

fn send_size_event(&self, flags: c_int)

This function sends a dummy size event to the window allowing it to re-layout its children positions.

fn send_size_event_to_parent(&self, flags: c_int)

Safe wrapper for GetParent()->SendSizeEvent().

fn set_client_size_int(&self, width: c_int, height: c_int)

This sets the size of the window client area in pixels.

fn set_client_size_size<S: SizeMethods>(&self, size: &S)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_client_size_rect<R: RectMethods>(&self, rect: &R)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_containing_sizer<S: SizerMethods>(&self, sizer: Option<&S>)

Used by wxSizer internally to notify the window about being managed by the given sizer.

fn set_initial_size<S: SizeMethods>(&self, size: &S)

A smart SetSize that will fill in default size components with the window’s best size values.

fn set_max_client_size<S: SizeMethods>(&self, size: &S)

Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area.

fn set_max_size<S: SizeMethods>(&self, size: &S)

Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size.

fn set_min_client_size<S: SizeMethods>(&self, size: &S)

Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window’s client area.

fn set_min_size<S: SizeMethods>(&self, size: &S)

Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size.

fn set_size_int_int( &self, x: c_int, y: c_int, width: c_int, height: c_int, size_flags: c_int, )

Sets the size of the window in pixels.

fn set_size_rect<R: RectMethods>(&self, rect: &R)

Sets the size of the window in pixels.

fn set_size_size<S: SizeMethods>(&self, size: &S)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_size_int(&self, width: c_int, height: c_int)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_size_hints_size<S: SizeMethods, S2: SizeMethods, S3: SizeMethods>( &self, min_size: &S, max_size: &S2, inc_size: &S3, )

Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged.

fn set_size_hints_int( &self, min_w: c_int, min_h: c_int, max_w: c_int, max_h: c_int, inc_w: c_int, inc_h: c_int, )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn set_virtual_size_int(&self, width: c_int, height: c_int)

Sets the virtual size of the window in pixels.

fn set_virtual_size_size<S: SizeMethods>(&self, size: &S)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_dip_size_window<S: SizeMethods, W: WindowMethods>( sz: &S, w: Option<&W>, ) -> Size

Non window-specific DPI-independent pixels conversion functions.

fn from_dip_point_window<P: PointMethods, W: WindowMethods>( pt: &P, w: Option<&W>, ) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_dip_int_window<W: WindowMethods>(d: c_int, w: Option<&W>) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_dip_size_window<S: SizeMethods, W: WindowMethods>( sz: &S, w: Option<&W>, ) -> Size

Non window-specific pixel to DPI-independent pixels conversion functions.

fn to_dip_point_window<P: PointMethods, W: WindowMethods>( pt: &P, w: Option<&W>, ) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_dip_int_window<W: WindowMethods>(d: c_int, w: Option<&W>) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_phys_size_window<S: SizeMethods, W: WindowMethods>( sz: &S, w: Option<&W>, ) -> Size

Convert from physical pixels to logical pixels for any window.

fn from_phys_point_window<P: PointMethods, W: WindowMethods>( pt: &P, w: Option<&W>, ) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn from_phys_int_window<W: WindowMethods>(d: c_int, w: Option<&W>) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_phys_size_window<S: SizeMethods, W: WindowMethods>( sz: &S, w: Option<&W>, ) -> Size

Convert from logical pixels to physical pixels for any window.

fn to_phys_point_window<P: PointMethods, W: WindowMethods>( pt: &P, w: Option<&W>, ) -> Point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn to_phys_int_window<W: WindowMethods>(d: c_int, w: Option<&W>) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn center(&self, dir: c_int)

A synonym for Centre().

fn center_on_parent(&self, dir: c_int)

A synonym for CentreOnParent().

fn centre(&self, direction: c_int)

Centres the window.

fn centre_on_parent(&self, direction: c_int)

Centres the window on its parent.

fn get_position_int(&self, x: *mut c_void, y: *mut c_void)

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

fn get_position(&self) -> Point

This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows.

fn get_rect(&self) -> Rect

Returns the position and size of the window as a wxRect object.

fn get_screen_position_int(&self, x: *mut c_void, y: *mut c_void)

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

fn get_screen_position(&self) -> Point

Returns the window position in screen coordinates, whether the window is a child window or a top level one.

fn get_screen_rect(&self) -> Rect

Returns the position and size of the window on the screen as a wxRect object.

fn get_client_area_origin(&self) -> Point

Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations…)

fn get_client_rect(&self) -> Rect

Get the client rectangle in window (i.e. client) coordinates.

fn move_int(&self, x: c_int, y: c_int, flags: c_int)

Moves the window to the given position.

fn move_point<P: PointMethods>(&self, pt: &P, flags: c_int)

Moves the window to the given position.

fn set_position<P: PointMethods>(&self, pt: &P)

Moves the window to the specified position.

fn client_to_screen_int(&self, x: *mut c_void, y: *mut c_void)

Converts to screen coordinates from coordinates relative to this window.

fn client_to_screen_point<P: PointMethods>(&self, pt: &P) -> Point

Converts to screen coordinates from coordinates relative to this window.

fn convert_dialog_to_pixels_point<P: PointMethods>(&self, pt: &P) -> Point

Converts a point or size from dialog units to pixels.

fn convert_dialog_to_pixels_size<S: SizeMethods>(&self, sz: &S) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn convert_pixels_to_dialog_point<P: PointMethods>(&self, pt: &P) -> Point

Converts a point or size from pixels to dialog units.

fn convert_pixels_to_dialog_size<S: SizeMethods>(&self, sz: &S) -> Size

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn screen_to_client_int(&self, x: *mut c_void, y: *mut c_void)

Converts from screen to client window coordinates.

fn screen_to_client_point<P: PointMethods>(&self, pt: &P) -> Point

Converts from screen to client window coordinates.

fn clear_background(&self)

Clears the window by filling it with the current background colour.

fn freeze(&self)

Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.

fn thaw(&self)

Re-enables window updating after a previous call to Freeze().

fn is_frozen(&self) -> bool

Returns true if the window is currently frozen by a call to Freeze().

fn get_background_colour(&self) -> Colour

Returns the background colour of the window.

fn get_char_height(&self) -> c_int

Returns the character height for this window.

fn get_char_width(&self) -> c_int

Returns the average character width for this window.

fn get_dpi(&self) -> Size

Return the DPI of the display used by this window.

fn get_font(&self) -> Font

Returns the font for this window.

fn get_foreground_colour(&self) -> Colour

Returns the foreground colour of the window.

fn get_text_extent_int<F: FontMethods>( &self, string: &str, w: *mut c_void, h: *mut c_void, descent: *mut c_void, external_leading: *mut c_void, font: Option<&F>, )

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

fn get_text_extent(&self, string: &str) -> Size

Gets the dimensions of the string as it would be drawn on the window with the currently selected font.

fn get_update_client_rect(&self) -> Rect

Get the update rectangle bounding box in client coords.

fn has_transparent_background(&self) -> bool

Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background.

fn refresh<R: RectMethods>(&self, erase_background: bool, rect: Option<&R>)

Causes this window, and all of its children recursively, to be repainted.

fn refresh_rect<R: RectMethods>(&self, rect: &R, erase_background: bool)

Redraws the contents of the given rectangle: only the area inside it will be repainted.

fn update(&self)

Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop).

fn set_background_colour<C: ColourMethods>(&self, colour: &C) -> bool

Sets the background colour of the window.

fn is_transparent_background_supported(&self, reason: *mut c_void) -> bool

Checks whether using transparent background might work.

fn set_font<F: FontMethods>(&self, font: &F) -> bool

Sets the font for this window.

fn set_foreground_colour<C: ColourMethods>(&self, colour: &C) -> bool

Sets the foreground colour of the window.

fn set_own_background_colour<C: ColourMethods>(&self, colour: &C)

Sets the background colour of the window but prevents it from being inherited by the children of this window.

fn inherits_background_colour(&self) -> bool

Return true if this window inherits the background colour from its parent.

fn use_bg_col(&self) -> bool

Return true if a background colour has been set for this window.

fn use_background_colour(&self) -> bool

Return true if a background colour has been set for this window.

fn set_own_font<F: FontMethods>(&self, font: &F)

Sets the font of the window but prevents it from being inherited by the children of this window.

fn set_own_foreground_colour<C: ColourMethods>(&self, colour: &C)

Sets the foreground colour of the window but prevents it from being inherited by the children of this window.

fn use_foreground_colour(&self) -> bool

Return true if a foreground colour has been set for this window.

fn inherits_foreground_colour(&self) -> bool

Return true if this window inherits the foreground colour from its parent.

fn set_palette<P: PaletteMethods>(&self, pal: &P)

See C++ wxWindow::SetPalette()’s documentation.

fn should_inherit_colours(&self) -> bool

Return true from here to allow the colours of this window to be changed by InheritAttributes().

fn set_theme_enabled(&self, enable: bool)

This function tells a window if it should use the system’s “theme” code to draw the windows’ background instead of its own background drawing code.

fn get_theme_enabled(&self) -> bool

Returns true if the window uses the system theme for drawing its background.

fn can_set_transparent(&self) -> bool

Returns true if the system supports transparent windows and calling SetTransparent() may succeed.

fn set_transparent(&self, alpha: c_uchar) -> bool

Set the transparency of the window.

fn get_event_handler(&self) -> WeakRef<EvtHandler>

Returns the event handler for this window.

fn handle_as_navigation_key<K: KeyEventMethods>(&self, event: &K) -> bool

This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case.

fn handle_window_event<E: EventMethods>(&self, event: &E) -> bool

Shorthand for:

fn process_window_event<E: EventMethods>(&self, event: &E) -> bool

Convenient wrapper for ProcessEvent().

fn process_window_event_locally<E: EventMethods>(&self, event: &E) -> bool

Wrapper for wxEvtHandler::ProcessEventLocally().

fn pop_event_handler(&self, delete_handler: bool) -> WeakRef<EvtHandler>

Removes and returns the top-most event handler on the event handler stack.

fn push_event_handler<E: EvtHandlerMethods>(&self, handler: Option<&E>)

Pushes this event handler onto the event stack for the window.

fn remove_event_handler<E: EvtHandlerMethods>( &self, handler: Option<&E>, ) -> bool

Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack.

fn set_event_handler<E: EvtHandlerMethods>(&self, handler: Option<&E>)

Sets the event handler for this window.

fn get_extra_style(&self) -> c_long

Returns the extra style bits for the window.

fn get_window_style_flag(&self) -> c_long

Gets the window style that was passed to the constructor or Create() method.

fn get_window_style(&self) -> c_long

See GetWindowStyleFlag() for more info.

fn has_extra_style(&self, ex_flag: c_int) -> bool

Returns true if the window has the given exFlag bit set in its extra styles.

fn has_flag(&self, flag: c_int) -> bool

Returns true if the window has the given flag bit set.

fn set_extra_style(&self, ex_style: c_long)

Sets the extra style bits for the window.

fn set_window_style_flag(&self, style: c_long)

Sets the style of the window.

fn set_window_style(&self, style: c_long)

See SetWindowStyleFlag() for more info.

fn toggle_window_style(&self, flag: c_int) -> bool

Turns the given flag on if it’s currently turned off and vice versa.

fn move_after_in_tab_order<W: WindowMethods>(&self, win: Option<&W>)

Moves this window in the tab navigation order after the specified win.

fn move_before_in_tab_order<W: WindowMethods>(&self, win: Option<&W>)

Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it.

fn navigate(&self, flags: c_int) -> bool

Performs a keyboard navigation action starting from this window.

fn navigate_in(&self, flags: c_int) -> bool

Performs a keyboard navigation action inside this window.

fn lower(&self)

Lowers the window to the bottom of the window hierarchy (Z-order).

fn raise(&self)

Raises the window to the top of the window hierarchy (Z-order).

fn hide(&self) -> bool

Equivalent to calling wxWindow::Show(false).

fn is_enabled(&self) -> bool

Returns true if the window is enabled, i.e. if it accepts user input, false otherwise.

fn is_exposed_int(&self, x: c_int, y: c_int) -> bool

Returns true if the given point or rectangle area has been exposed since the last repaint.

fn is_exposed_point<P: PointMethods>(&self, pt: &P) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn is_exposed_int_int(&self, x: c_int, y: c_int, w: c_int, h: c_int) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn is_exposed_rect<R: RectMethods>(&self, rect: &R) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn is_shown(&self) -> bool

Returns true if the window is shown, false if it has been hidden.

fn is_shown_on_screen(&self) -> bool

Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well.

fn disable(&self) -> bool

Disables the window.

fn enable(&self, enable: bool) -> bool

Enable or disable the window for user input.

fn show(&self, show: bool) -> bool

Shows or hides the window.

fn set_help_text(&self, help_text: &str)

Sets the help text to be used as context-sensitive help for this window.

fn get_tool_tip(&self) -> Option<ToolTipIsOwned<false>>

Get the associated tooltip or NULL if none.

fn get_tool_tip_text(&self) -> String

Get the text of the associated tooltip or empty string if none.

fn set_tool_tip_str(&self, tip_string: &str)

Attach a tooltip to the window.

fn set_tool_tip_tooltip<T: ToolTipMethods>(&self, tip: Option<&T>)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn unset_tool_tip(&self)

Unset any existing tooltip.

fn get_popup_menu_selection_from_user_point<M: MenuMethods, P: PointMethods>( &self, menu: &M, pos: &P, ) -> c_int

This function shows a popup menu at the given position in this window and returns the selected id.

fn get_popup_menu_selection_from_user_int<M: MenuMethods>( &self, menu: &M, x: c_int, y: c_int, ) -> c_int

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn popup_menu_point<M: MenuMethods, P: PointMethods>( &self, menu: Option<&M>, pos: &P, ) -> bool

Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu.

fn popup_menu_int<M: MenuMethods>( &self, menu: Option<&M>, x: c_int, y: c_int, ) -> bool

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

fn get_validator(&self) -> WeakRef<Validator>

Validator functions.

fn set_validator<V: ValidatorMethods>(&self, validator: &V)

Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type.

fn transfer_data_from_window(&self) -> bool

Transfers values from child controls to data areas specified by their validators.

fn transfer_data_to_window(&self) -> bool

Transfers values to child controls from data areas specified by their validators.

fn validate(&self) -> bool

Validates the current values of the child controls using their validators.

fn get_id(&self) -> c_int

Returns the identifier of the window.

fn get_label(&self) -> String

Generic way of getting a label from any window, for identification purposes.

fn get_layout_direction(&self) -> c_int

Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported.

fn adjust_for_layout_direction( &self, x: c_int, width: c_int, width_total: c_int, ) -> c_int

Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32.

fn get_name(&self) -> String

Returns the window’s name.

fn set_id(&self, winid: c_int)

Sets the identifier of the window.

fn set_label(&self, label: &str)

Sets the window’s label.

fn set_layout_direction(&self, dir: c_int)

Sets the layout direction for this window.

fn set_name(&self, name: &str)

Sets the window’s name.

fn get_accelerator_table(&self) -> Option<AcceleratorTableIsOwned<false>>

Gets the accelerator table for this window.

fn set_accelerator_table<A: AcceleratorTableMethods>(&self, accel: &A)

Sets the accelerator table for this window.

fn close(&self, force: bool) -> bool

This function simply generates a wxCloseEvent whose handler usually tries to close the window.

fn destroy(&self) -> bool

Destroys the window safely.

fn is_being_deleted(&self) -> bool

Returns true if this window is in process of being destroyed.

fn get_drop_target(&self) -> Option<DropTargetIsOwned<false>>

Returns the associated drop target, which may be NULL.

fn set_drop_target<D: DropTargetMethods>(&self, target: Option<&D>)

Associates a drop target with this window.

fn drag_accept_files(&self, accept: bool)

Enables or disables eligibility for drop file events (OnDropFiles).

fn get_containing_sizer(&self) -> Option<SizerIsOwned<false>>

Returns the sizer of which this window is a member, if any, otherwise NULL.

fn get_sizer(&self) -> Option<SizerIsOwned<false>>

Returns the sizer associated with the window by a previous call to SetSizer(), or NULL.

fn set_sizer<S: SizerMethods>(&self, sizer: Option<&S>, delete_old: bool)

Sets the window to have the given layout sizer.

fn set_sizer_and_fit<S: SizerMethods>( &self, sizer: Option<&S>, delete_old: bool, )

Associate the sizer with the window and set the window size and minimal size accordingly.

fn get_constraints(&self) -> *mut c_void

Returns a pointer to the window’s layout constraints, or NULL if there are none.

fn set_constraints(&self, constraints: *mut c_void)

Sets the window to have the given layout constraints.

fn layout(&self) -> bool

Lays out the children of this window using the associated sizer.

fn set_auto_layout(&self, auto_layout: bool)

Determines whether the Layout() function will be called automatically when the window is resized.

fn get_auto_layout(&self) -> bool

Returns true if Layout() is called automatically when the window is resized.

fn capture_mouse(&self)

Directs all mouse input to this window.

fn get_caret(&self) -> Option<CaretIsOwned<false>>

Returns the caret() associated with the window.

fn has_capture(&self) -> bool

Returns true if this window has the current mouse capture.

fn release_mouse(&self)

Releases mouse input captured with CaptureMouse().

fn set_caret<C: CaretMethods>(&self, caret: Option<&C>)

Sets the caret() associated with the window.

fn set_cursor<C: CursorMethods>(&self, cursor: &C) -> bool

Sets the window’s cursor.

fn warp_pointer(&self, x: c_int, y: c_int)

Moves the pointer to the given position on the window.

fn enable_touch_events(&self, events_mask: c_int) -> bool

Request generation of touch events for this window.

fn do_update_window_ui<U: UpdateUIEventMethods>(&self, event: &U)

Does the window-specific updating after processing the update event.

fn has_multiple_pages(&self) -> bool

This method should be overridden to return true if this window has multiple pages.

fn inherit_attributes(&self)

This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours.

fn init_dialog(&self)

Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators.

fn is_double_buffered(&self) -> bool

Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later.

fn set_double_buffered(&self, on: bool)

Turn on or off double buffering of the window if the system supports it.

fn is_retained(&self) -> bool

Returns true if the window is retained, false otherwise.

fn is_this_enabled(&self) -> bool

Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called.

fn is_top_level(&self) -> bool

Returns true if the given window is a top-level one.

fn on_internal_idle(&self)

This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class.

fn send_idle_events(&self, event: *mut c_void) -> bool

Send idle event to window and all subwindows.

fn register_hot_key( &self, hotkey_id: c_int, modifiers: c_int, virtual_key_code: c_int, ) -> bool

Registers a system wide hotkey.

fn unregister_hot_key(&self, hotkey_id: c_int) -> bool

Unregisters a system wide hotkey.

fn update_window_ui(&self, flags: c_long)

This function sends one or more wxUpdateUIEvent to the window.

fn find_focus() -> WeakRef<Window>

Finds the window or control which currently has the keyboard focus.

fn find_window_by_id<W: WindowMethods>( id: c_long, parent: Option<&W>, ) -> WeakRef<Window>

Find the first window with the given id.

fn find_window_by_label<W: WindowMethods>( label: &str, parent: Option<&W>, ) -> WeakRef<Window>

Find a window by its label.

fn find_window_by_name<W: WindowMethods>( name: &str, parent: Option<&W>, ) -> WeakRef<Window>

Find a window by its name (as given in a window constructor or Create() function call).

fn get_capture() -> WeakRef<Window>

Returns the currently captured window.

fn new_control_id(count: c_int) -> c_int

Create a new ID or range of IDs that are not currently in use.

fn unreserve_control_id(id: c_int, count: c_int)

Unreserve an ID or range of IDs that was reserved by NewControlId().

fn create<W: WindowMethods, P: PointMethods, S: SizeMethods>( &self, parent: Option<&W>, id: c_int, pos: &P, size: &S, style: c_long, name: &str, ) -> bool

Construct the actual window object after creating the C++ object.

impl<const OWNED: bool> WxRustMethods for MiniFrameIsOwned<OWNED>

type Unowned = MiniFrameIsOwned<false>

unsafe fn as_ptr(&self) -> *mut c_void

unsafe fn from_ptr(ptr: *mut c_void) -> Self

unsafe fn from_unowned_ptr(ptr: *mut c_void) -> Self::Unowned

unsafe fn with_ptr<F: Fn(&Self)>(ptr: *mut c_void, closure: F)

unsafe fn option_from(ptr: *mut c_void) -> Option<Self::Unowned>

where Self: Sized,

impl<const OWNED: bool> MiniFrameMethods for MiniFrameIsOwned<OWNED>