Struct ParamSpecString

pub struct ParamSpecString { /* private fields */ }

A ParamSpec derived structure that contains the meta data for string properties.

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

Implementations

impl ParamSpecString

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

Return the inner pointer to the underlying C value.

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

Borrows the underlying C value.

impl ParamSpecString

pub fn upcast(self) -> ParamSpec

pub fn upcast_ref(&self) -> &ParamSpec

impl ParamSpecString

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

impl ParamSpecString

pub fn builder(name: &str) -> ParamSpecStringBuilder<'_>

Methods from Deref<Target = ParamSpec>

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

Return the inner pointer to the underlying C value.

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.

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

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.

pub fn name_quark(&self) -> Quark

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.

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.

Trait Implementations

impl AsRef<ParamSpec> for ParamSpecString

fn as_ref(&self) -> &ParamSpec

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

impl Clone for ParamSpecString

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 ParamSpecString

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

Formats the value using the given formatter.

impl Deref for ParamSpecString

type Target = ParamSpec

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for ParamSpecString

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 ParamSpecString

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ParamSpecString

impl ParamSpecType for ParamSpecString

impl Send for ParamSpecString

impl StructuralPartialEq for ParamSpecString

impl Sync for ParamSpecString