Struct glib::ParamSpec

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

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§

source§

impl ParamSpec

source

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

Return the inner pointer to the underlying C value.

source

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

Borrows the underlying C value.

source§

impl ParamSpec

source

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

source

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

source

pub fn type_(&self) -> Type

source

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

source

pub fn value_type(&self) -> Type

source

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

Available on crate feature v2_74 only.
source

pub fn owner_type(&self) -> Type

source

pub fn flags(&self) -> ParamFlags

source

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.

source

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

source

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.

source

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.

source

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.

source

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

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

source

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§

source§

impl AsRef<ParamSpec> for ParamSpec

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecBoolean

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecBoxed

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecChar

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecDouble

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecEnum

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecFlags

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecFloat

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecGType

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecInt

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecInt64

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecLong

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecObject

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecOverride

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecParam

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecPointer

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecString

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecUChar

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecUInt

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecUInt64

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecULong

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecUnichar

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecValueArray

source§

fn as_ref(&self) -> &ParamSpec

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

impl AsRef<ParamSpec> for ParamSpecVariant

source§

fn as_ref(&self) -> &ParamSpec

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

impl Clone for ParamSpec

source§

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.

1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ParamSpec

source§

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

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

impl Hash for ParamSpec

source§

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

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 ParamSpec

source§

fn cmp(&self, other: &ParamSpec) -> 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 PartialEq for ParamSpec

source§

fn eq(&self, other: &ParamSpec) -> 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 PartialOrd for ParamSpec

source§

fn partial_cmp(&self, other: &ParamSpec) -> 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 ParamSpec

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for ParamSpec

source§

impl Send for ParamSpec

source§

impl StructuralPartialEq for ParamSpec

source§

impl Sync for ParamSpec

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<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<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> ToSendValue for T
where T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
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,