Struct libpanel::SaveDelegate

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

Properties

icon

The “icon” property contains a gio::Icon that describes the save operation. Generally, this should be the symbolic icon of the document class you are saving.

Alternatively, you can use icon-name for a named icon.

Readable | Writeable

icon-name

The “icon-name” property contains the name of an icon to use when showing information about the save operation in UI such as a save dialog.

You can also use icon to set a gio::Icon instead of an icon name.

Readable | Writeable

is-draft

The “is-draft” property indicates that the document represented by the delegate is a draft and might be lost of not saved.

Readable | Writeable

progress

The “progress” property contains progress between 0.0 and 1.0 and should be updated by the delegate implementation as saving progresses.

Readable | Writeable

subtitle

The “subtitle” property contains additional information that may not make sense to put in the title. This might include the directory that the file will be saved within.

Readable | Writeable

title

The “title” property contains the title of the document being saved. Generally, this should be the base name of the document such as file.txt.

Readable | Writeable

Signals

close

This signal is emitted when the save delegate should close the widget it is related to. This can happen after saving as part of a close request and it is now save for the delegate to close.

Implementations are encouraged to connect to this signal (or implement the virtual method) and call [WidgetExt::force_close()][crate::prelude::WidgetExt::force_close()].

discard

This signal is emitted when the user has requested that the delegate discard the changes instead of saving them.

Implementations are encouraged to connect to this signal (or implement the virtual method) and revert the document to the last saved state and/or close the document.

save

This signal can be used when subclassing SaveDelegate is not possible or cumbersome. The default implementation of PanelSaveDelegateClass.save_async() will emit this signal to allow the consumer to implement asynchronous save in a flexible manner.

The caller is expected to complete task with a boolean when the save operation has completed.

Implements

SaveDelegateExt, glib::ObjectExt, SaveDelegateExtManual

Implementations

impl SaveDelegate

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

pub fn new() -> SaveDelegate

Create a new SaveDelegate.

Returns

a newly created SaveDelegate

pub fn builder() -> SaveDelegateBuilder

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

This method returns an instance of SaveDelegateBuilder which can be used to create SaveDelegate objects.

Trait Implementations

impl Clone for SaveDelegate

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SaveDelegate

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

Formats the value using the given formatter.

impl Default for SaveDelegate

fn default() -> Self

Returns the “default value” for a type.

impl Display for SaveDelegate

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

Formats the value using the given formatter.

impl HasParamSpec for SaveDelegate

type ParamSpec = ParamSpecObject

type SetValue = SaveDelegate

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SaveDelegate

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

Feeds this value into the given Hasher.

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<T: SaveDelegateImpl> IsSubclassable<T> for SaveDelegate

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for SaveDelegate

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for SaveDelegate

type Parent = Object

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

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

This method tests for self and other values to be equal, and is used by ==.

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 SaveDelegate

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

This method returns an ordering between self and other values if one exists.

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 SaveDelegate

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SaveDelegate