Struct gtk4::MenuButton

source ·

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

Expand description

The MenuButton widget is used to display a popup when clicked.

This popup can be provided either as a Popover or as an abstract GMenuModel.

The MenuButton widget can show either an icon (set with the property::MenuButton::icon-name property) or a label (set with the property::MenuButton::label property). If neither is explicitly set, a Image is automatically created, using an arrow image oriented according to property::MenuButton::direction or the generic “open-menu-symbolic” icon if the direction is not set.

The positioning of the popup is determined by the property::MenuButton::direction property of the menu button.

For menus, the property::Widget::halign and property::Widget::valign properties of the menu are also taken into account. For example, when the direction is ArrowType::Down and the horizontal alignment is Align::Start, the menu will be positioned below the button, with the starting edge (depending on the text direction) of the menu aligned with the starting edge of the button. If there is not enough space below the button, the menu is popped up above the button instead. If the alignment would move part of the menu offscreen, it is “pushed in”.

	start	center	end
down
up
left
right

CSS nodes

menubutton
╰── button.toggle
    ╰── <content>
         ╰── [arrow]

MenuButton has a single CSS node with name menubutton which contains a button node with a .toggle style class.

If the button contains an icon, it will have the .image-button style class, if it contains text, it will have .text-button style class. If an arrow is visible in addition to an icon, text or a custom child, it will also have .arrow-button style class.

Inside the toggle button content, there is an arrow node for the indicator, which will carry one of the .none, .up, .down, .left or .right style classes to indicate the direction that the menu will appear in. The CSS is expected to provide a suitable image for each of these cases using the -gtk-icon-source property.

Optionally, the menubutton node can carry the .circular style class to request a round appearance.

Accessibility

MenuButton uses the AccessibleRole::Button role.

Implements

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

Struct gtk4::MenuButton

Implementations§

impl MenuButton

pub fn new() -> MenuButton

pub fn builder() -> MenuButtonBuilder

pub fn must_always_show_arrow(&self) -> bool

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

pub fn direction(&self) -> ArrowType

pub fn has_frame(&self) -> bool

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

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

pub fn menu_model(&self) -> Option<MenuModel>

pub fn popover(&self) -> Option<Popover>

pub fn is_primary(&self) -> bool

pub fn uses_underline(&self) -> bool

pub fn popdown(&self)

pub fn popup(&self)

pub fn set_always_show_arrow(&self, always_show_arrow: bool)

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

pub fn set_create_popup_func<P: Fn(&MenuButton) + 'static>(&self, func: P)

pub fn set_direction(&self, direction: ArrowType)

pub fn set_has_frame(&self, has_frame: bool)

pub fn set_icon_name(&self, icon_name: &str)

pub fn set_label(&self, label: &str)

pub fn set_menu_model(&self, menu_model: Option<&impl IsA<MenuModel>>)

pub fn set_popover(&self, popover: Option<&impl IsA<Widget>>)

pub fn set_primary(&self, primary: 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_always_show_arrow_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

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

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

pub fn connect_icon_name_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_menu_model_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

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

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

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

impl MenuButton

pub fn unset_create_popup_func(&self)

Trait Implementations§

impl Clone for MenuButton

fn clone(&self) -> Self

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

impl Debug for MenuButton

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

impl Default for MenuButton

fn default() -> Self

impl Display for MenuButton

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

impl Hash for MenuButton

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

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

impl Ord for MenuButton

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

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

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

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

impl ParentClassIs for MenuButton

type Parent = Widget

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

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

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

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

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 MenuButton

fn static_type() -> Type

impl Eq for MenuButton

impl IsA<Accessible> for MenuButton

impl IsA<Buildable> for MenuButton

impl IsA<ConstraintTarget> for MenuButton

impl IsA<Widget> for MenuButton

Auto Trait Implementations§

impl RefUnwindSafe for MenuButton