Struct boing::Group

pub struct Group<'ui> { /* private fields */ }

A labeled container around a child control.

Groups enclose a single child control, providing a descriptive title of the contents. They are traditionally rendered as a rectangular border with an inline label. A group can optionally be margined, in which case empty space is inserted outside the border.

Implementations

impl<'ui> Group<'ui>

pub fn title(&self) -> String

The title of this group.

pub fn raw_title(&self) -> Result<&str, Error>

The lossless yet fallible version of title.

pub fn title_as_ptr(&self) -> *mut c_char

Like title but returns an ASCII byte string.

pub fn set_title(&self, title: impl Into<Vec<u8>>) -> Result<(), Error>

Sets the title of this group.

This overrides the title supplied to Ui::create_group.

pub fn set_child(&self, child: &'ui impl DerefMut<Target = Control>)

Sets the child control of this group.

This is unset by default.

pub fn clear(&self)

Clears the child control of this group if one is set.

pub fn is_margined(&self) -> bool

Determines if this group has margins.

Groups are not margined by default.

pub fn set_margined(&self, value: bool)

Sets whether or not this group has margins.

Methods from Deref<Target = Control>

pub fn is_visible(&self) -> bool

Determines if this control is visible.

Controls are visible by default except for Windows, which are invisible by default.

pub fn is_enabled(&self) -> bool

Determines if this control responds to user interaction.

Controls are enabled by default.

pub fn is_enabled_to_user(&self) -> bool

Determines if this control, and all of its parent controls, are enabled.

If this control is not a child of a parent control, then this function is equivalent to is_enabled.

pub fn native_handle(&self) -> *mut c_void

A handle to the underlying OS object.

pub fn show(&self)

Makes this control visible.

pub fn hide(&self)

Makes this control not visible.

pub fn enable(&self)

Makes this control enabled.

pub fn disable(&self)

Makes this control not enabled.

Trait Implementations

impl<'ui> Deref for Group<'ui>

type Target = Control

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'ui> DerefMut for Group<'ui>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'ui> Widget for Group<'ui>

type Handle = uiGroup

The corresponding libui-ng type.

fn as_ptr(&self) -> *mut Self::Handle

A handle to the underlying libui-ng object.