Struct ParamSpec

pub struct ParamSpec { /* private fields */ }

GParamSpec encapsulates the metadata required to specify parameters, such as GObject properties.

Parameter names

A property name consists of one or more segments consisting of ASCII letters and digits, separated by either the - or _ character. The first character of a property name must be a letter. These are the same rules as for signal naming (see [funcObject]).

When creating and looking up a GParamSpec, either separator can be used, but they cannot be mixed. Using - is considerably more efficient, and is the ‘canonical form’. Using _ is discouraged.

This is an Abstract Base Class, you cannot instantiate it. GParamSpec encapsulates the metadata required to specify parameters, such as GObject properties.

Parameter names

A property name consists of one or more segments consisting of ASCII letters and digits, separated by either the - or _ character. The first character of a property name must be a letter. These are the same rules as for signal naming (see [funcObject]).

When creating and looking up a GParamSpec, either separator can be used, but they cannot be mixed. Using - is considerably more efficient, and is the ‘canonical form’. Using _ is discouraged.

This is an Abstract Base Class, you cannot instantiate it.

GLib type: Shared boxed type with reference counted clone semantics.

Implementations

impl ParamSpec

pub fn as_ptr(&self) -> *mut GParamSpec

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GParamSpec) -> &Self

Borrows the underlying C value.

impl ParamSpec

pub fn downcast<T: ParamSpecType>(self) -> Result<T, ParamSpec>

pub fn downcast_ref<T: ParamSpecType>(&self) -> Option<&T>

pub fn type_(&self) -> Type

pub fn is<T: StaticType>(&self) -> bool

pub fn value_type(&self) -> Type

pub fn value_is_valid(&self, value: &Value) -> bool

Available on crate feature v2_74 only.

pub fn owner_type(&self) -> Type

pub fn flags(&self) -> ParamFlags

pub fn blurb(&self) -> Option<&str>

Get the short description of a ParamSpec.

Returns

the short description of self. Get the short description of a ParamSpec.

Returns

the short description of self.

pub fn default_value(&self) -> &Value

Gets the default value of self as a pointer to a Value.

The Value will remain valid for the life of self.

Returns

a pointer to a Value which must not be modified Gets the default value of self as a pointer to a Value.

The Value will remain valid for the life of self.

Returns

a pointer to a Value which must not be modified

pub fn name<'a>(&self) -> &'a str

Get the name of a ParamSpec.

The name is always an “interned” string (as per g_intern_string()). This allows for pointer-value comparisons.

Returns

the name of self. Get the name of a ParamSpec.

The name is always an “interned” string (as per g_intern_string()). This allows for pointer-value comparisons.

Returns

the name of self.

pub fn name_quark(&self) -> Quark

Gets the GQuark for the name.

Returns

the GQuark for self->name. Gets the GQuark for the name.

Returns

the GQuark for self->name.

pub fn nick(&self) -> &str

Returns the nickname of this ParamSpec.

If this ParamSpec does not have a nickname, the nickname of its redirect target is returned if it has one. Otherwise, self.name() is returned. Get the nickname of a ParamSpec.

Returns

the nickname of self. Get the nickname of a ParamSpec.

Returns

the nickname of self.

pub fn redirect_target(&self) -> Option<ParamSpec>

contains references to other environment variables, they are expanded.

variable

the environment variable to get

Returns

the value of the environment variable, or None if the environment variable is not found. The returned string may be overwritten by the next call to g_getenv(), g_setenv() or g_unsetenv(). If the paramspec redirects operations to another paramspec, returns that paramspec. Redirect is used typically for providing a new implementation of a property in a derived type while preserving all the properties from the parent type. Redirection is established by creating a property of type ParamSpecOverride. See g_object_class_override_property() for an example of the use of this capability.

Returns

paramspec to which requests on this paramspec should be redirected, or None if none.

pub fn is_valid_name(name: &str) -> bool

Available on crate feature v2_66 only.

Validate a property name for a ParamSpec. This can be useful for dynamically-generated properties which need to be validated at run-time before actually trying to create them.

See [canonical parameter names][classObjectparameter-names] for details of the rules for valid names.

name

the canonical name of the property

Returns

true if name is a valid property name, false otherwise. Validate a property name for a ParamSpec. This can be useful for dynamically-generated properties which need to be validated at run-time before actually trying to create them.

See [canonical parameter names][classObjectparameter-names] for details of the rules for valid names.

name

the canonical name of the property

Returns

true if name is a valid property name, false otherwise.

Trait Implementations

impl AsRef<ParamSpec> for ParamSpec

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecBoolean

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecBoxed

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecChar

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecDouble

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecEnum

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecFlags

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecFloat

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecGType

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecInt

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecInt64

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecLong

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecObject

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecOverride

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecParam

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecPointer

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecString

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecUChar

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecUInt

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecUInt64

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecULong

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecUnichar

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecValueArray

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<ParamSpec> for ParamSpecVariant

fn as_ref(&self) -> &ParamSpec

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ParamSpec

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for ParamSpec

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

Formats the value using the given formatter.

impl Hash for ParamSpec

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

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 Ord for ParamSpec

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

This method returns an Ordering between self and other.

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,

Restrict a value to a certain interval.

impl PartialEq for ParamSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ParamSpec

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for ParamSpec

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ParamSpec

impl Send for ParamSpec

impl StructuralPartialEq for ParamSpec

impl Sync for ParamSpec