Struct gtk4::PrintSettings

source ·
pub struct PrintSettings { /* private fields */ }
Expand description

A PrintSettings object represents the settings of a print dialog in a system-independent way.

The main use for this object is that once you’ve printed you can get a settings object that represents the settings the user chose, and the next time you print you can pass that object in so that the user doesn’t have to re-set all his settings.

Its also possible to enumerate the settings so that you can easily save the settings for the next time your app runs, or even store them in a document. The predefined keys try to use shared values as much as possible so that moving such a document between systems still works.

§Implements

[trait@glib::ObjectExt]

Implementations§

source§

impl PrintSettings

source

pub fn new() -> PrintSettings

Creates a new PrintSettings object.

§Returns

a new PrintSettings object

source

pub fn from_file(file_name: impl AsRef<Path>) -> Result<PrintSettings, Error>

Reads the print settings from @file_name.

Returns a new PrintSettings object with the restored settings, or None if an error occurred. If the file could not be loaded then error is set to either a GFileError or GKeyFileError.

See to_file().

§file_name

the filename to read the settings from

§Returns

the restored PrintSettings

source

pub fn from_gvariant(variant: &Variant) -> PrintSettings

Deserialize print settings from an a{sv} variant.

The variant must be in the format produced by to_gvariant().

§variant

an a{sv} GVariant

§Returns

a new PrintSettings object

source

pub fn from_key_file( key_file: &KeyFile, group_name: Option<&str> ) -> Result<PrintSettings, Error>

Reads the print settings from the group @group_name in @key_file.

Returns a new PrintSettings object with the restored settings, or None if an error occurred. If the file could not be loaded then error is set to either GFileError or GKeyFileError.

§key_file

the GKeyFile to retrieve the settings from

§group_name

the name of the group to use, or None to use the default “Print Settings”

§Returns

the restored PrintSettings

source

pub fn copy(&self) -> PrintSettings

source

pub fn foreach<P: FnMut(&str, &str)>(&self, func: P)

Calls @func for each key-value pair of @self.

§func

the function to call

source

pub fn get(&self, key: &str) -> Option<GString>

Looks up the string value associated with @key.

§key

a key

§Returns

the string value for @key

source

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

Returns the boolean represented by the value that is associated with @key.

The string “true” represents true, any other string false.

§key

a key

§Returns

true, if @key maps to a true value.

source

pub fn is_collate(&self) -> bool

Gets the value of PRINT_SETTINGS_COLLATE.

§Returns

whether to collate the printed pages

source

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

Gets the value of PRINT_SETTINGS_DEFAULT_SOURCE.

§Returns

the default source

source

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

Gets the value of PRINT_SETTINGS_DITHER.

§Returns

the dithering that is used

source

pub fn double(&self, key: &str) -> f64

Returns the double value associated with @key, or 0.

§key

a key

§Returns

the double value of @key

source

pub fn double_with_default(&self, key: &str, def: f64) -> f64

Returns the floating point number represented by the value that is associated with @key, or @default_val if the value does not represent a floating point number.

Floating point numbers are parsed with g_ascii_strtod().

§key

a key

§def

the default value

§Returns

the floating point number associated with @key

source

pub fn duplex(&self) -> PrintDuplex

Gets the value of PRINT_SETTINGS_DUPLEX.

§Returns

whether to print the output in duplex.

source

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

Gets the value of PRINT_SETTINGS_FINISHINGS.

§Returns

the finishings

source

pub fn int(&self, key: &str) -> i32

Returns the integer value of @key, or 0.

§key

a key

§Returns

the integer value of @key

source

pub fn int_with_default(&self, key: &str, def: i32) -> i32

Returns the value of @key, interpreted as an integer, or the default value.

§key

a key

§def

the default value

§Returns

the integer value of @key

source

pub fn length(&self, key: &str, unit: Unit) -> f64

Returns the value associated with @key, interpreted as a length.

The returned value is converted to @units.

§key

a key

§unit

the unit of the return value

§Returns

the length value of @key, converted to @unit

source

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

Gets the value of PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

§Returns

the media type

source

pub fn n_copies(&self) -> i32

Gets the value of PRINT_SETTINGS_N_COPIES.

§Returns

the number of copies to print

source

pub fn number_up(&self) -> i32

Gets the value of PRINT_SETTINGS_NUMBER_UP.

§Returns

the number of pages per sheet

source

pub fn number_up_layout(&self) -> NumberUpLayout

Gets the value of PRINT_SETTINGS_NUMBER_UP_LAYOUT.

§Returns

layout of page in number-up mode

source

pub fn orientation(&self) -> PageOrientation

Get the value of PRINT_SETTINGS_ORIENTATION, converted to a PageOrientation.

§Returns

the orientation

source

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

Gets the value of PRINT_SETTINGS_OUTPUT_BIN.

§Returns

the output bin

source

pub fn page_ranges(&self) -> Vec<PageRange>

Gets the value of PRINT_SETTINGS_PAGE_RANGES.

§Returns

an array of PageRanges. Use g_free() to free the array when it is no longer needed.

source

pub fn page_set(&self) -> PageSet

Gets the value of PRINT_SETTINGS_PAGE_SET.

§Returns

the set of pages to print

source

pub fn paper_height(&self, unit: Unit) -> f64

Gets the value of PRINT_SETTINGS_PAPER_HEIGHT, converted to @unit.

§unit

the unit for the return value

§Returns

the paper height, in units of @unit

source

pub fn paper_size(&self) -> Option<PaperSize>

Gets the value of PRINT_SETTINGS_PAPER_FORMAT, converted to a PaperSize.

§Returns

the paper size

source

pub fn paper_width(&self, unit: Unit) -> f64

Gets the value of PRINT_SETTINGS_PAPER_WIDTH, converted to @unit.

§unit

the unit for the return value

§Returns

the paper width, in units of @unit

source

pub fn print_pages(&self) -> PrintPages

Gets the value of PRINT_SETTINGS_PRINT_PAGES.

§Returns

which pages to print

source

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

Convenience function to obtain the value of PRINT_SETTINGS_PRINTER.

§Returns

the printer name

source

pub fn printer_lpi(&self) -> f64

Gets the value of PRINT_SETTINGS_PRINTER_LPI.

§Returns

the resolution in lpi (lines per inch)

source

pub fn quality(&self) -> PrintQuality

Gets the value of PRINT_SETTINGS_QUALITY.

§Returns

the print quality

source

pub fn resolution(&self) -> i32

Gets the value of PRINT_SETTINGS_RESOLUTION.

§Returns

the resolution in dpi

source

pub fn resolution_x(&self) -> i32

Gets the value of PRINT_SETTINGS_RESOLUTION_X.

§Returns

the horizontal resolution in dpi

source

pub fn resolution_y(&self) -> i32

Gets the value of PRINT_SETTINGS_RESOLUTION_Y.

§Returns

the vertical resolution in dpi

source

pub fn is_reverse(&self) -> bool

Gets the value of PRINT_SETTINGS_REVERSE.

§Returns

whether to reverse the order of the printed pages

source

pub fn scale(&self) -> f64

Gets the value of PRINT_SETTINGS_SCALE.

§Returns

the scale in percent

source

pub fn uses_color(&self) -> bool

Gets the value of PRINT_SETTINGS_USE_COLOR.

§Returns

whether to use color

source

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

Returns true, if a value is associated with @key.

§key

a key

§Returns

true, if @key has a value

source

pub fn load_file(&self, file_name: impl AsRef<Path>) -> Result<(), Error>

Reads the print settings from @file_name.

If the file could not be loaded then error is set to either a GFileError or GKeyFileError.

See to_file().

§file_name

the filename to read the settings from

§Returns

true on success

source

pub fn load_key_file( &self, key_file: &KeyFile, group_name: Option<&str> ) -> Result<(), Error>

Reads the print settings from the group @group_name in @key_file.

If the file could not be loaded then error is set to either a GFileError or GKeyFileError.

§key_file

the GKeyFile to retrieve the settings from

§group_name

the name of the group to use, or None to use the default “Print Settings”

§Returns

true on success

source

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

Associates @value with @key.

§key

a key

§value

a string value

source

pub fn set_bool(&self, key: &str, value: bool)

Sets @key to a boolean value.

§key

a key

§value

a boolean

source

pub fn set_collate(&self, collate: bool)

Sets the value of PRINT_SETTINGS_COLLATE.

§collate

whether to collate the output

source

pub fn set_default_source(&self, default_source: &str)

Sets the value of PRINT_SETTINGS_DEFAULT_SOURCE.

§default_source

the default source

source

pub fn set_dither(&self, dither: &str)

Sets the value of PRINT_SETTINGS_DITHER.

§dither

the dithering that is used

source

pub fn set_double(&self, key: &str, value: f64)

Sets @key to a double value.

§key

a key

§value

a double value

source

pub fn set_duplex(&self, duplex: PrintDuplex)

Sets the value of PRINT_SETTINGS_DUPLEX.

§duplex

a PrintDuplex value

source

pub fn set_finishings(&self, finishings: &str)

Sets the value of PRINT_SETTINGS_FINISHINGS.

§finishings

the finishings

source

pub fn set_int(&self, key: &str, value: i32)

Sets @key to an integer value.

§key

a key

§value

an integer

source

pub fn set_length(&self, key: &str, value: f64, unit: Unit)

Associates a length in units of @unit with @key.

§key

a key

§value

a length

§unit

the unit of @length

source

pub fn set_media_type(&self, media_type: &str)

Sets the value of PRINT_SETTINGS_MEDIA_TYPE.

The set of media types is defined in PWG 5101.1-2002 PWG.

§media_type

the media type

source

pub fn set_n_copies(&self, num_copies: i32)

Sets the value of PRINT_SETTINGS_N_COPIES.

§num_copies

the number of copies

source

pub fn set_number_up(&self, number_up: i32)

Sets the value of PRINT_SETTINGS_NUMBER_UP.

§number_up

the number of pages per sheet

source

pub fn set_number_up_layout(&self, number_up_layout: NumberUpLayout)

Sets the value of PRINT_SETTINGS_NUMBER_UP_LAYOUT.

§number_up_layout

a NumberUpLayout value

source

pub fn set_orientation(&self, orientation: PageOrientation)

Sets the value of PRINT_SETTINGS_ORIENTATION.

§orientation

a page orientation

source

pub fn set_output_bin(&self, output_bin: &str)

Sets the value of PRINT_SETTINGS_OUTPUT_BIN.

§output_bin

the output bin

source

pub fn set_page_set(&self, page_set: PageSet)

Sets the value of PRINT_SETTINGS_PAGE_SET.

§page_set

a PageSet value

source

pub fn set_paper_height(&self, height: f64, unit: Unit)

Sets the value of PRINT_SETTINGS_PAPER_HEIGHT.

§height

the paper height

§unit

the units of @height

source

pub fn set_paper_size(&self, paper_size: &PaperSize)

source

pub fn set_paper_width(&self, width: f64, unit: Unit)

Sets the value of PRINT_SETTINGS_PAPER_WIDTH.

§width

the paper width

§unit

the units of @width

source

pub fn set_print_pages(&self, pages: PrintPages)

Sets the value of PRINT_SETTINGS_PRINT_PAGES.

§pages

a PrintPages value

source

pub fn set_printer(&self, printer: &str)

Convenience function to set PRINT_SETTINGS_PRINTER to @printer.

§printer

the printer name

source

pub fn set_printer_lpi(&self, lpi: f64)

Sets the value of PRINT_SETTINGS_PRINTER_LPI.

§lpi

the resolution in lpi (lines per inch)

source

pub fn set_quality(&self, quality: PrintQuality)

Sets the value of PRINT_SETTINGS_QUALITY.

§quality

a PrintQuality value

source

pub fn set_resolution(&self, resolution: i32)

Sets the values of PRINT_SETTINGS_RESOLUTION, PRINT_SETTINGS_RESOLUTION_X and PRINT_SETTINGS_RESOLUTION_Y.

§resolution

the resolution in dpi

source

pub fn set_resolution_xy(&self, resolution_x: i32, resolution_y: i32)

Sets the values of PRINT_SETTINGS_RESOLUTION, PRINT_SETTINGS_RESOLUTION_X and PRINT_SETTINGS_RESOLUTION_Y.

§resolution_x

the horizontal resolution in dpi

§resolution_y

the vertical resolution in dpi

source

pub fn set_reverse(&self, reverse: bool)

Sets the value of PRINT_SETTINGS_REVERSE.

§reverse

whether to reverse the output

source

pub fn set_scale(&self, scale: f64)

Sets the value of PRINT_SETTINGS_SCALE.

§scale

the scale in percent

source

pub fn set_use_color(&self, use_color: bool)

Sets the value of PRINT_SETTINGS_USE_COLOR.

§use_color

whether to use color

source

pub fn to_file(&self, file_name: impl AsRef<Path>) -> Result<(), Error>

This function saves the print settings from @self to @file_name.

If the file could not be written then error is set to either a GFileError or GKeyFileError.

§file_name

the file to save to

§Returns

true on success

source

pub fn to_gvariant(&self) -> Variant

Serialize print settings to an a{sv} variant.

§Returns

a new, floating, GVariant

source

pub fn to_key_file(&self, key_file: &KeyFile, group_name: Option<&str>)

This function adds the print settings from @self to @key_file.

§key_file

the GKeyFile to save the print settings to

§group_name

the group to add the settings to in @key_file, or None to use the default “Print Settings”

source

pub fn unset(&self, key: &str)

Removes any value associated with @key.

This has the same effect as setting the value to None.

§key

a key

source§

impl PrintSettings

source

pub fn set_page_ranges(&self, page_ranges: &[PageRange])

Sets the value of PRINT_SETTINGS_PAGE_RANGES.

§page_ranges

an array of PageRanges

Trait Implementations§

source§

impl Clone for PrintSettings

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PrintSettings

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for PrintSettings

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl HasParamSpec for PrintSettings

§

type ParamSpec = ParamSpecObject

§

type SetValue = PrintSettings

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for PrintSettings

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for PrintSettings

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl ParentClassIs for PrintSettings

source§

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

source§

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

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

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.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl StaticType for PrintSettings

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for PrintSettings

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

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

Upcasts an object to a superclass or interface T. Read more
source§

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

Upcasts an object to a reference of its superclass or interface T. Read more
source§

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

Tries to downcast to a subclass or interface implementor T. Read more
source§

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

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

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

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
source§

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

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

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

Casts to T unconditionally. Read more
source§

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

Casts to &T unconditionally. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<U> IsSubclassableExt for U

source§

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

source§

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

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

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

Returns the ObjectClass of the object. Read more
source§

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

Returns the class of the object.
source§

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

Returns the class of the object in the given type T. Read more
source§

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

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

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

Sets multiple properties of the object at once. Read more
source§

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

Sets multiple properties of the object at once. Read more
source§

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

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

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

Set arbitrary data on this object with the given key. Read more
source§

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

Return previously set arbitrary data of this object with the given key. Read more
source§

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

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

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

Set arbitrary data on this object with the given key. Read more
source§

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

Return previously set arbitrary data of this object with the given key. Read more
source§

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

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

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

Connect to the signal signal_name on this object. Read more
source§

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

Connect to the signal signal_id on this object. Read more
source§

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

Connect to the signal signal_name on this object. Read more
source§

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

Connect to the signal signal_id on this object. Read more
source§

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

Connect to the signal signal_name on this object. Read more
source§

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

Connect to the signal signal_id on this object. Read more
source§

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

Connect a closure to the signal signal_name on this object. Read more
source§

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

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

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

Emit signal by signal id. Read more
source§

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

Same as Self::emit but takes Value for the arguments.
source§

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

Emit signal by its name. Read more
source§

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

Emit signal by its name. Read more
source§

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

Emit signal by its name with details. Read more
source§

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

Emit signal by its name with details. Read more
source§

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

Emit signal by signal id with details. Read more
source§

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

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

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

Connect to the notify signal of the object. Read more
source§

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

Connect to the notify signal of the object. Read more
source§

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

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

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

Add a callback to be notified when the Object is disposed.
source§

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

Add a callback to be notified when the Object is disposed. Read more
source§

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

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

source§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,