Struct gtk4::Expander

source · [−]

#[repr(transparent)]
pub struct Expander { /* private fields */ }

Expand description

Expander allows the user to reveal its child by clicking on an expander triangle.

An example GtkExpander

This is similar to the triangles used in a TreeView.

Normally you use an expander as you would use a frame; you create the child widget and use set_child() to add it to the expander. When the expander is toggled, it will take care of showing and hiding the child automatically.

Special Usage

There are situations in which you may prefer to show and hide the expanded widget yourself, such as when you want to actually create the widget at expansion time. In this case, create a Expander but do not add a child to it. The expander widget has an property::Expander::expanded[ property which can be used to monitor its expansion state. You should watch this property with a signal connection as follows:

⚠️ The following code is in c ⚠️

static void
expander_callback (GObject    *object,
                   GParamSpec *param_spec,
                   gpointer    user_data)
{
  GtkExpander *expander;

  expander = GTK_EXPANDER (object);

  if (gtk_expander_get_expanded (expander))
    {
      // Show or create widgets
    }
  else
    {
      // Hide or destroy widgets
    }
}

static void
create_expander (void)
{
  GtkWidget *expander = gtk_expander_new_with_mnemonic ("_More Options");
  g_signal_connect (expander, "notify::expanded",
                    G_CALLBACK (expander_callback), NULL);

  // ...
}

GtkExpander as GtkBuildable

The Expander implementation of the Buildable interface supports placing a child in the label position by specifying “label” as the “type” attribute of a element. A normal content child can be specified without specifying a type attribute.

An example of a UI definition fragment with GtkExpander:

<object class="GtkExpander">
  <child type="label">
    <object class="GtkLabel" id="expander-label"/>
  </child>
  <child>
    <object class="GtkEntry" id="expander-content"/>
  </child>
</object>

CSS nodes

expander
╰── box
    ├── title
    │   ├── arrow
    │   ╰── <label widget>
    ╰── <child>

Expander has three CSS nodes, the main node with the name expander, a subnode with name title and node below it with name arrow. The arrow of an expander that is showing its child gets the :checked pseudoclass added to it.

Accessibility

Expander uses the AccessibleRole::Button role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Struct gtk4::Expander

Implementations

impl Expander

pub fn new(label: Option<&str>) -> Expander

pub fn with_mnemonic(label: &str) -> Expander

pub fn builder() -> ExpanderBuilder

pub fn child(&self) -> Option<Widget>

pub fn is_expanded(&self) -> bool

pub fn label(&self) -> Option<GString>

pub fn label_widget(&self) -> Option<Widget>

pub fn resizes_toplevel(&self) -> bool

pub fn uses_markup(&self) -> bool

pub fn uses_underline(&self) -> bool

pub fn set_child(&self, child: Option<&impl IsA<Widget>>)

pub fn set_expanded(&self, expanded: bool)

pub fn set_label(&self, label: Option<&str>)

pub fn set_label_widget(&self, label_widget: Option<&impl IsA<Widget>>)

pub fn set_resize_toplevel(&self, resize_toplevel: bool)

pub fn set_use_markup(&self, use_markup: bool)

pub fn set_use_underline(&self, use_underline: bool)

pub fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

pub fn emit_activate(&self)

pub fn connect_child_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_expanded_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_label_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_label_widget_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_resize_toplevel_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_use_markup_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

pub fn connect_use_underline_notify<F: Fn(&Self) + 'static>( &self, f: F) -> SignalHandlerId

Trait Implementations

impl Clone for Expander

fn clone(&self) -> Self

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

impl Debug for Expander

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Default for Expander

fn default() -> Self

impl Display for Expander

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Hash for Expander

fn hash<H>(&self, state: &mut H) where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl Ord for Expander

fn cmp(&self, other: &Self) -> Ordering

fn max(self, other: Self) -> Self

fn min(self, other: Self) -> Self

fn clamp(self, min: Self, max: Self) -> Self

impl ParentClassIs for Expander

type Parent = Widget

impl<OT: ObjectType> PartialEq<OT> for Expander

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

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

impl<OT: ObjectType> PartialOrd<OT> for Expander

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

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

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

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

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

impl StaticType for Expander

fn static_type() -> Type

impl Eq for Expander

impl IsA<Accessible> for Expander

impl IsA<Buildable> for Expander

impl IsA<ConstraintTarget> for Expander

impl IsA<Widget> for Expander

Auto Trait Implementations

impl RefUnwindSafe for Expander

impl !Send for Expander

impl !Sync for Expander

impl Unpin for Expander

impl UnwindSafe for Expander

Blanket Implementations

impl<O> AccessibleExtManual for O where O: IsA<Accessible>,

pub fn update_property(&Self, &[Property<'_>])

pub fn update_relation(&Self, &[Relation<'_>])

pub fn update_state(&Self, &[State])

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

pub fn connect_child_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_expanded_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_label_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_label_widget_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_resize_toplevel_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_use_markup_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

pub fn connect_use_underline_notify<F: Fn(&Self) + 'static>(
&self,
f: F
) -> SignalHandlerId

fn hash<H>(&self, state: &mut H) where
H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<O> AccessibleExtManual for O where
O: IsA<Accessible>,

pub fn update_state(&Self, &[State ])

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

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

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

impl<T> Cast for T where
T: ObjectType,

fn upcast<T>(self) -> T where
T: ObjectType,
Self: IsA<T>,

fn upcast_ref<T>(&self) -> &T where
T: ObjectType,
Self: IsA<T>,

fn downcast<T>(self) -> Result<T, Self> where
T: ObjectType,
Self: CanDowncast<T>,

fn downcast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
Self: CanDowncast<T>,

fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,

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

impl<U> IsSubclassableExt for U where
U: IsClass + ParentClassIs,

pub fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

pub fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for T where
T: ObjectType,

pub fn is<U>(&self) -> bool where
U: StaticType,

pub fn class(&self) -> &Class<T> where
T: IsClass,

pub fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass,

pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,

pub fn try_set_property<V>(
&self,
property_name: &str,
value: V
) -> Result<(), BoolError> where
V: ToValue,

pub fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,

pub fn try_set_property_from_value(
&self,
property_name: &str,
value: &Value
) -> Result<(), BoolError>

pub fn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue )]
) -> Result<(), BoolError>

pub fn set_properties(&self, property_values: &[(&str, &dyn ToValue )])

pub fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value )]
) -> Result<(), BoolError>

pub fn set_properties_from_value(&self, property_values: &[(&str, Value )])

pub fn try_property<V>(&self, property_name: &str) -> Result<V, BoolError> where
V: 'static + for<'b> FromValue<'b>,

pub fn property<V>(&self, property_name: &str) -> V where
V: 'static + for<'b> FromValue<'b>,

pub fn try_property_value(
&self,
property_name: &str
) -> Result<Value, BoolError>