Struct libpanel::SessionItem

pub struct SessionItem { /* private fields */ }

Properties

id

Readable | Writeable

module-name

Readable | Writeable

position

Readable | Writeable

type-hint

Readable | Writeable

workspace

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl SessionItem

pub fn new() -> SessionItem

pub fn builder() -> SessionItemBuilder

Creates a new builder-pattern struct instance to construct SessionItem objects.

This method returns an instance of SessionItemBuilder which can be used to create SessionItem objects.

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

Gets the id for the session item, if any.

Returns

a string containing the id; otherwise None

pub fn metadata_value( &self, key: &str, expected_type: Option<&VariantTy>, ) -> Option<Variant>

Retrieves the metadata value for key.

If expected_type is non-None, any non-None value returned from this function will match expected_type.

key

the metadata key

expected_type

a glib::VariantType or None

Returns

a non-floating glib::Variant which should be released with g_variant_unref(); otherwise None.

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

Gets the module-name that created an item.

Returns

a module-name or None

pub fn position(&self) -> Option<Position>

Gets the Position for the item.

Returns

a Position or None

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

Gets the type hint for an item.

Returns

a type-hint or None

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

Gets the workspace id for the item.

Returns

a workspace or None

pub fn has_metadata_with_type( &self, key: &str, expected_type: &VariantTy, ) -> bool

Checks if the item contains metadata key with expected_type.

key

the metadata key

expected_type

the glib::VariantType to check for key

Returns

true if a value was found for key matching expected_typed; otherwise false is returned.

pub fn set_id(&self, id: Option<&str>)

Sets the identifier for the item.

The identifier should generally be global to the session as it would not be expected to come across multiple items with the same id.

id

an optional identifier for the item

pub fn set_metadata_value(&self, key: &str, value: Option<&Variant>)

Sets the value for metadata key.

If value is None, the metadata key is unset.

key

the metadata key

value

the value for key or None

pub fn set_module_name(&self, module_name: Option<&str>)

Sets the module-name for the session item.

This is generally used to help determine which plugin created the item when decoding them at project load time.

module_name

the module name owning the item

pub fn set_position(&self, position: Option<&Position>)

Sets the position for self, if any.

position

a Position or None

pub fn set_type_hint(&self, type_hint: Option<&str>)

Sets the type-hint value for the item.

This is generally used to help inflate the right version of an object when loading session items.

type_hint

a type hint string for the item

pub fn set_workspace(&self, workspace: Option<&str>)

Sets the workspace id for the item.

This is generally used to tie an item to a specific workspace.

workspace

a workspace string for the item

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

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

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

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

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

impl SessionItem

pub fn metadata<T: FromVariant>(&self, key: &str) -> Option<T>

Extract a metadata value matching format.

format must not reference the glib::Variant, which means you need to make copies of data, such as “s” instead of “&s”.

key

the key for the metadata value

format

the format of the value

Returns

true if key was found with format and parameters were set.

pub fn has_metadata(&self, key: &str) -> bool

If the item contains a metadata value for key.

Checks if a value exists for a metadata key and retrieves the glib::VariantType for that key.

key

the name of the metadata

Returns

true if self contains metadata named key and value_type is set to the value’s glib::VariantType. Otherwise false and value_type is unchanged.

value_type

a location for a glib::VariantType or None

pub fn metadata_type(&self, key: &str) -> Option<VariantType>

pub fn set_metadata<T: ToVariant>(&self, key: &str, value: Option<T>)

A variadic helper to set metadata.

The format should be identical to [glib::Variant::new()][crate::glib::Variant::new()].

Trait Implementations

impl Clone for SessionItem

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

Performs copy-assignment from source.

impl Debug for SessionItem

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

Formats the value using the given formatter.

impl Default for SessionItem

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SessionItem

type ParamSpec = ParamSpecObject

type SetValue = SessionItem

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, SessionItem>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SessionItem

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SessionItem

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for SessionItem

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SessionItem

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SessionItem