Struct gtk::Popover

source · [−]

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

Expand description

GtkPopover is a bubble-like context window, primarily meant to provide context-dependent information or options. Popovers are attached to a widget, passed at construction time on new(), or updated afterwards through PopoverExt::set_relative_to(), by default they will point to the whole widget area, although this behavior can be changed through PopoverExt::set_pointing_to().

The position of a popover relative to the widget it is attached to can also be changed through PopoverExt::set_position().

By default, Popover performs a GTK+ grab, in order to ensure input events get redirected to it while it is shown, and also so the popover is dismissed in the expected situations (clicks outside the popover, or the Esc key being pressed). If no such modal behavior is desired on a popover, PopoverExt::set_modal() may be called on it to tweak its behavior.

GtkPopover is often used to replace menus. To facilitate this, it supports being populated from a gio::MenuModel, using from_model(). In addition to all the regular menu model features, this function supports rendering sections in the model in a more compact form, as a row of icon buttons instead of menu items.

To use this rendering, set the ”display-hint” attribute of the section to ”horizontal-buttons” and set the icons of your items with the ”verb-icon” attribute.

<section>
  <attribute name="display-hint">horizontal-buttons</attribute>
  <item>
    <attribute name="label">Cut</attribute>
    <attribute name="action">app.cut</attribute>
    <attribute name="verb-icon">edit-cut-symbolic</attribute>
  </item>
  <item>
    <attribute name="label">Copy</attribute>
    <attribute name="action">app.copy</attribute>
    <attribute name="verb-icon">edit-copy-symbolic</attribute>
  </item>
  <item>
    <attribute name="label">Paste</attribute>
    <attribute name="action">app.paste</attribute>
    <attribute name="verb-icon">edit-paste-symbolic</attribute>
  </item>
</section>

CSS nodes

GtkPopover has a single css node called popover. It always gets the .background style class and it gets the .menu style class if it is menu-like (e.g. PopoverMenu or created using from_model().

Particular uses of GtkPopover, such as touch selection popups or magnifiers in Entry or TextView get style classes like .touch-selection or .magnifier to differentiate from plain popovers.

Implements

PopoverExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Struct gtk::Popover

Implementations

impl Popover

pub const NONE: Option<&'static Popover> = None

pub fn new(relative_to: Option<&impl IsA<Widget>>) -> Popover

pub fn from_model( relative_to: Option<&impl IsA<Widget>>, model: &impl IsA<MenuModel>) -> Popover

pub fn builder() -> PopoverBuilder

Trait Implementations

impl Clone for Popover

fn clone(&self) -> Self

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

impl Debug for Popover

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

impl Default for Popover

fn default() -> Self

impl Display for Popover

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

impl Hash for Popover

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 Popover

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

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

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

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

impl ParentClassIs for Popover

type Parent = Bin

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

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

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

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

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

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

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

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

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

impl StaticType for Popover

fn static_type() -> Type

impl Eq for Popover

impl IsA<Bin> for Popover

impl IsA<Buildable> for Popover

impl IsA<Container> for Popover

impl IsA<Popover> for PopoverMenu

impl IsA<Widget> for Popover

Auto Trait Implementations

impl RefUnwindSafe for Popover

impl !Send for Popover

impl !Sync for Popover

impl Unpin for Popover

impl UnwindSafe for Popover

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Cast for Twhere T: ObjectType,

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

fn upcast_ref<T>(&self) -> &Twhere 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) -> Twhere T: ObjectType,

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

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

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

impl<T> ObjectExt for Twhere T: ObjectType,

fn is<U>(&self) -> boolwhere U: StaticType,

fn type_(&self) -> Type

fn object_class(&self) -> &Class<Object>

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

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

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

pub fn from_model(
relative_to: Option<&impl IsA<Widget>>,
model: &impl IsA<MenuModel>
) -> Popover

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

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

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

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

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

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

impl<T> Cast for Twhere
T: ObjectType,

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

fn upcast_ref<T>(&self) -> &Twhere
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) -> Twhere
T: ObjectType,

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

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

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

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

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

impl<T> ObjectExt for Twhere
T: ObjectType,

fn is<U>(&self) -> boolwhere
U: StaticType,

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

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

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

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

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

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,

fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,

fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value> + Send + Sync,

fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value>,

fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: 'static + Fn(&[Value]) -> Option<Value>,

unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,

unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> SignalHandlerIdwhere
F: Fn(&[Value]) -> Option<Value>,

fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure
) -> SignalHandlerId

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value]
) -> Option<Value>

fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value]
) -> Option<Value>

fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Rwhere
R: TryFromClosureReturnValue,

fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Option<Value>

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerIdwhere
F: 'static + Fn(&T, &ParamSpec),

unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerIdwhere
F: Fn(&T, &ParamSpec),

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>where
F: 'static + FnOnce() + Send,

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>where
F: 'static + FnOnce(),

fn bind_property<'f, 't, O>(
&'a self,
source_property: &'a str,
target: &'a O,
target_property: &'a str
) -> BindingBuilder<'a, 'f, 't>where
O: ObjectType,

impl<T> StaticTypeExt for Twhere
T: StaticType,

impl<T> ToClosureReturnValue for Twhere
T: ToValue,

impl<T> ToOwned for Twhere
T: Clone,