Struct gdk::Visual

source · [−]

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

Expand description

A Visual contains information about a particular visual.

Implementations

source

impl Visual

source

pub fn bits_per_rgb(&self) -> i32

Returns the number of significant bits per red, green and blue value.

Not all GDK backend provide a meaningful value for this function.

Deprecated since 3.22

Use red_pixel_details() and its variants to learn about the pixel layout of TrueColor and DirectColor visuals

Returns

The number of significant bits per color value for self.

source

pub fn blue_pixel_details(&self) -> (u32, i32, i32 )

Obtains values that are needed to calculate blue pixel values in TrueColor and DirectColor. The “mask” is the significant bits within the pixel. The “shift” is the number of bits left we must shift a primary for it to be in position (according to the “mask”). Finally, “precision” refers to how much precision the pixel value contains for a particular primary.

Returns

`mask`

A pointer to a guint32 to be filled in, or None

`shift`

A pointer to a gint to be filled in, or None

`precision`

A pointer to a gint to be filled in, or None

source

pub fn byte_order(&self) -> ByteOrder

Returns the byte order of this visual.

The information returned by this function is only relevant when working with XImages, and not all backends return meaningful information for this.

Deprecated since 3.22

This information is not useful

Returns

A ByteOrder stating the byte order of self.

source

pub fn colormap_size(&self) -> i32

Returns the size of a colormap for this visual.

You have to use platform-specific APIs to manipulate colormaps.

Deprecated since 3.22

This information is not useful, since GDK does not provide APIs to operate on colormaps.

Returns

The size of a colormap that is suitable for self.

source

pub fn depth(&self) -> i32

Returns the bit depth of this visual.

Returns

The bit depth of this visual.

source

pub fn green_pixel_details(&self) -> (u32, i32, i32 )

Obtains values that are needed to calculate green pixel values in TrueColor and DirectColor. The “mask” is the significant bits within the pixel. The “shift” is the number of bits left we must shift a primary for it to be in position (according to the “mask”). Finally, “precision” refers to how much precision the pixel value contains for a particular primary.

Returns

`mask`

A pointer to a guint32 to be filled in, or None

`shift`

A pointer to a gint to be filled in, or None

`precision`

A pointer to a gint to be filled in, or None

source

pub fn red_pixel_details(&self) -> (u32, i32, i32 )

Obtains values that are needed to calculate red pixel values in TrueColor and DirectColor. The “mask” is the significant bits within the pixel. The “shift” is the number of bits left we must shift a primary for it to be in position (according to the “mask”). Finally, “precision” refers to how much precision the pixel value contains for a particular primary.

Returns

`mask`

A pointer to a guint32 to be filled in, or None

`shift`

A pointer to a gint to be filled in, or None

`precision`

A pointer to a gint to be filled in, or None

source

pub fn screen(&self) -> Screen

Gets the screen to which this visual belongs

Returns

the screen to which this visual belongs.

source

pub fn visual_type(&self) -> VisualType

Returns the type of visual this is (PseudoColor, TrueColor, etc).

Returns

A VisualType stating the type of self.

source

pub fn best() -> Visual

Get the visual with the most available colors for the default GDK screen. The return value should not be freed.

Deprecated since 3.22

Visual selection should be done using Screen::system_visual() and Screen::rgba_visual()

Returns

best visual

source

pub fn best_depth() -> i32

Get the best available depth for the default GDK screen. “Best” means “largest,” i.e. 32 preferred over 24 preferred over 8 bits per pixel.

Deprecated since 3.22

Visual selection should be done using Screen::system_visual() and Screen::rgba_visual()

Returns

best available depth

source

pub fn best_type() -> VisualType

Return the best available visual type for the default GDK screen.

Deprecated since 3.22

Visual selection should be done using Screen::system_visual() and Screen::rgba_visual()

Returns

best visual type

source

pub fn best_with_both(depth: i32, visual_type: VisualType) -> Option<Visual>

Combines best_with_depth() and best_with_type().

Deprecated since 3.22

Visual selection should be done using Screen::system_visual() and Screen::rgba_visual()

`depth`

a bit depth

`visual_type`

a visual type

Returns

best visual with both depth and visual_type, or None if none

source

pub fn best_with_depth(depth: i32) -> Option<Visual>

Get the best visual with depth depth for the default GDK screen. Color visuals and visuals with mutable colormaps are preferred over grayscale or fixed-colormap visuals. The return value should not be freed. None may be returned if no visual supports depth.

Deprecated since 3.22

Visual selection should be done using Screen::system_visual() and Screen::rgba_visual()

`depth`

a bit depth

Returns

best visual for the given depth

source

pub fn best_with_type(visual_type: VisualType) -> Option<Visual>

Get the best visual of the given visual_type for the default GDK screen. Visuals with higher color depths are considered better. The return value should not be freed. None may be returned if no visual has type visual_type.

Deprecated since 3.22

Visual selection should be done using Screen::system_visual() and Screen::rgba_visual()

`visual_type`

a visual type

Returns

best visual of the given type

source

pub fn system() -> Visual

Get the system’s default visual for the default GDK screen. This is the visual for the root window of the display. The return value should not be freed.

Deprecated since 3.22

Use gdk_screen_get_system_visual (gdk_screen_get_default ()).

Returns

system visual

source

impl Visual

source

pub fn query_depths() -> Vec<i32>

Trait Implementations

source

impl Clone for Visual

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 Visual

source

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

Formats the value using the given formatter. Read more

source

impl Display for Visual

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Visual

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,

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

source

impl Ord for Visual

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl ParentClassIs for Visual

type Parent = Object

source

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

source

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

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

1.0.0 · source

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

This method tests for !=.

source

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

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 Visual

source

fn static_type() -> Type

Returns the type identifier of Self.

source

impl Eq for Visual

Auto Trait Implementations

impl RefUnwindSafe for Visual

impl !Send for Visual

impl !Sync for Visual

impl Unpin for Visual

impl UnwindSafe for Visual

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · 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: CanDowncast<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: CanDowncast<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 downcast and upcast will do many checks at compile-time already. 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

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 IsSubclassableExt for U where
U: IsClass + ParentClassIs,

source

fn parent_class_init<T>(class: &mut Class) where
T: ObjectSubclass,
::Parent: IsSubclassable<T>,

source

fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
::Parent: IsSubclassable<T>,

source

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

source

fn is(&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(&self) -> Option<&Class> where
U: IsClass,

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

source

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

Returns the interface T of the object. Read more

source

fn try_set_property<V>(
 &self,
 property_name: &str,
 value: V
) -> Result<(), BoolError> where
 V: ToValue,

Similar to Self::set_property but fails instead of panicking.

source

fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,

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

source

fn try_set_property_from_value(
 &self,
 property_name: &str,
 value: &Value
) -> Result<(), BoolError>

Similar to Self::set_property but fails instead of panicking.

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 try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue )]
) -> Result<(), BoolError>

Similar to Self::set_properties but fails instead of panicking.

source

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

Sets multiple properties of the object at once. Read more

source

fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value )]
) -> Result<(), BoolError>

Similar to Self::set_properties_from_value but fails instead of panicking.

source

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

Sets multiple properties of the object at once. Read more

source

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

Similar to Self::property but fails instead of panicking.

source

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

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

source

fn try_property_value(&self, property_name: &str) -> Result<Value, BoolError>

Similar to Self::property_value but fails instead of panicking.

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 try_connect<F>(
 &self,
 signal_name: &str,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: 'static + Fn(&[Value ]) -> Option<Value> + Send + Sync,

Similar to Self::connect but fails instead of panicking.

source

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

Connect to the signal signal_name on this object. Read more

source

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

Similar to Self::connect_id but fails instead of panicking.

source

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

Connect to the signal signal_id on this object. Read more

source

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

Similar to Self::connect_local but fails instead of panicking.

source

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

Connect to the signal signal_name on this object. Read more

source

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

Similar to Self::connect_local_id but fails instead of panicking.

source

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

Connect to the signal signal_id on this object. Read more

source

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

Similar to Self::connect_unsafe but fails instead of panicking.

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 try_connect_unsafe_id<F>(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 callback: F
) -> Result<SignalHandlerId, BoolError> where
 F: Fn(&[Value ]) -> Option<Value>,

Similar to Self::connect_unsafe_id but fails instead of panicking.

source

fn try_connect_closure(
 &self,
 signal_name: &str,
 after: bool,
 closure: RustClosure
) -> Result<SignalHandlerId, BoolError>

Similar to Self::connect_closure but fails instead of panicking.

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 try_connect_closure_id(
 &self,
 signal_id: SignalId,
 details: Option<Quark>,
 after: bool,
 closure: RustClosure
) -> Result<SignalHandlerId, BoolError>

Similar to Self::connect_closure_id but fails instead of panicking.

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 Closure::invoke. Read more

source