Struct TabsContainer

Source
pub struct TabsContainer {
    pub handle: ControlHandle,
    /* private fields */
}
Expand description

A tabs container is a frame-like control that can contain Tab control. Tabs are added by specifying the TabsContainer as parent in the Tab builder.

Do not add other control type as children to the TabsContainer

Requires the tabs feature

Builder parameters:

  • parent: Required. The button parent container.
  • position: The tab container position.
  • font: The font used for the tabs title
  • flags: A combination of the TabsContainerFlags values.
  • ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
  • image_list: The image list specifying the tabs icons

Control events:

  • TabsContainerChanged: The select tab of a TabsContainer changed
  • TabsContainerChanging: The selected tab of a TabsContainer is about to be changed
  • MousePress(_): Generic mouse press events on the button
  • OnMouseMove: Generic mouse mouse event
  • OnMouseWheel: Generic mouse wheel event

Fields§

§handle: ControlHandle

Implementations§

Source§

impl TabsContainer

Source

pub fn builder<'a>() -> TabsContainerBuilder<'a>

Source

pub fn selected_tab(&self) -> usize

Return the index of the currently selected tab May return usize::max_value() if no tab is selected

Source

pub fn set_selected_tab(&self, index: usize)

Set the currently selected tab by index

Source

pub fn tab_count(&self) -> usize

Return the number of tabs in the view

Source

pub fn set_image_list(&self, list: Option<&ImageList>)

Sets the image list of the tab container. Pass None to remove the image list.

This is only available is the feature “image-list” is enabled.

Source

pub fn image_list(&self) -> Option<ImageList>

Returns a reference to the current image list in the tab container. The image list is not owned and dropping it won’t free the resources.

This is only available is the feature “image-list” is enabled.

Source

pub fn focus(&self) -> bool

Return true if the control currently has the keyboard focus

Source

pub fn set_focus(&self)

Set the keyboard focus on the button.

Source

pub fn enabled(&self) -> bool

Return true if the control user can interact with the control, return false otherwise

Source

pub fn set_enabled(&self, v: bool)

Enable or disable the control

Source

pub fn visible(&self) -> bool

Return true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

Source

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

Source

pub fn size(&self) -> (u32, u32)

Return the size of the tabs container in the parent window

Source

pub fn set_size(&self, x: u32, y: u32)

Set the size of the tabs container in the parent window

Source

pub fn position(&self) -> (i32, i32)

Return the position of the tabs container in the parent window

Source

pub fn set_position(&self, x: i32, y: i32)

Set the position of the tabs container in the parent window

Source

pub fn font(&self) -> Option<Font>

Return the font of the control

Source

pub fn set_font(&self, font: Option<&Font>)

Set the font of the control

Source

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

Source

pub fn flags(&self) -> u32

Winapi base flags used during window creation

Source

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations§

Source§

impl Default for TabsContainer

Source§

fn default() -> TabsContainer

Returns the “default value” for a type. Read more
Source§

impl Drop for TabsContainer

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl From<&TabsContainer> for ControlHandle

Source§

fn from(control: &TabsContainer) -> Self

Converts to this type from the input type.
Source§

impl From<&mut TabsContainer> for ControlHandle

Source§

fn from(control: &mut TabsContainer) -> Self

Converts to this type from the input type.
Source§

impl PartialEq<ControlHandle> for TabsContainer

Source§

fn eq(&self, other: &ControlHandle) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq<TabsContainer> for ControlHandle

Source§

fn eq(&self, other: &TabsContainer) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialEq for TabsContainer

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.