Struct gdk::Visual[−][src]

pub struct Visual(_);

Expand description

A Visual contains information about a particular visual.

Implementations

[src]

impl Visual

[src]

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.

[src]

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

[src]

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.

[src]

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.

[src]

pub fn depth(&self) -> i32

Returns the bit depth of this visual.

Returns

The bit depth of this visual.

[src]

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

[src]

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

[src]

pub fn screen(&self) -> Screen

Gets the screen to which this visual belongs

Returns

the screen to which this visual belongs.

[src]

pub fn visual_type(&self) -> VisualType

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

Returns

A VisualType stating the type of self.

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

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

[src]

impl Visual

[src]

pub fn query_depths() -> Vec<i32>

Trait Implementations

[src]

impl Clone for Visual

[src]

fn clone(&self) -> Visual

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for Visual

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Display for Visual

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Hash for Visual

[src]

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

Feeds this value into the given Hasher. Read more

1.3.0[src]

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

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

[src]

impl Ord for Visual

[src]

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

This method returns an Ordering between self and other. Read more

1.21.0[src]

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

Compares and returns the maximum of two values. Read more

1.21.0[src]

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

Compares and returns the minimum of two values. Read more

1.50.0[src]

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

Restrict a value to a certain interval. Read more

[src]

impl ParentClassIs for Visual

type Parent = Object

[src]

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

[src]

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

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

1.0.0[src]

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

This method tests for !=.

[src]

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

[src]

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

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

1.0.0[src]

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[src]

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[src]

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[src]

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

[src]

impl StaticType for Visual

[src]

fn static_type() -> Type

Returns the type identifier of Self.

[src]

impl Eq for Visual

[src]

impl StructuralEq 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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

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

[src]

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

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

[src]

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

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

[src]

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

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

[src]

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

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

[src]

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

[src]

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

[src]

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

Casts to T unconditionally. Read more

[src]

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

Casts to &T unconditionally. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

[src]

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

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

[src]

pub fn type_(&self) -> Type

[src]

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

[src]

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

[src]

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

[src]

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

[src]

pub fn set_properties(
    &self, 
    property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>

[src]

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

[src]

pub fn set_property<'a, N, V>(
    &self, 
    property_name: N, 
    value: V
) -> Result<(), BoolError> where
    N: Into<&'a str>,
    V: ToValue,

[src]

pub fn set_property_from_value<'a, N>(
    &self, 
    property_name: N, 
    value: &Value
) -> Result<(), BoolError> where
    N: Into<&'a str>,

[src]

pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
    N: Into<&'a str>,

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

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

Safety Read more

[src]

pub fn block_signal(&self, handler_id: &SignalHandlerId)

[src]

pub fn unblock_signal(&self, handler_id: &SignalHandlerId)

[src]

pub fn stop_signal_emission(&self, signal_name: &str)

[src]

pub fn disconnect(&self, handler_id: SignalHandlerId)

[src]

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

[src]

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

[src]

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

[src]

pub fn notify<'a, N>(&self, property_name: N) where
    N: Into<&'a str>,

[src]

pub fn notify_by_pspec(&self, pspec: &ParamSpec)

[src]

pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
    N: Into<&'a str>,

[src]

pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
    N: Into<&'a str>,

[src]

pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
    N: Into<&'a str>,

[src]

pub fn list_properties(&self) -> Vec<ParamSpec, Global>

[src]

pub fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

[src]

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

[src]

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

Same as connect but takes a SignalId instead of a signal name.

[src]

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

[src]

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

Same as connect_local but takes a SignalId instead of a signal name.

[src]

pub unsafe fn connect_unsafe<'a, N, F>(
    &self, 
    signal_name: N, 
    after: bool, 
    callback: F
) -> Result<SignalHandlerId, BoolError> where
    F: Fn(&[Value]) -> Option<Value>,
    N: Into<&'a str>,

[src]

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

Same as connect_unsafe but takes a SignalId instead of a signal name.

[src]

pub fn emit(
    &self, 
    signal_id: SignalId, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal by signal id.

[src]

pub fn emit_with_details(
    &self, 
    signal_id: SignalId, 
    details: Quark, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>

Emit signal with details by signal id.

[src]

pub fn emit_by_name<'a, N>(
    &self, 
    signal_name: N, 
    args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Emit signal by it’s name.

[src]

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

[src]

pub fn bind_property<'a, O, N, M>(
    &'a self, 
    source_property: N, 
    target: &'a O, 
    target_property: M
) -> BindingBuilder<'a> where
    O: ObjectType,
    M: Into<&'a str>,
    N: Into<&'a str>,

[src]

pub fn ref_count(&self) -> u32

[src]

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

Same as emit but takes Value for the arguments.

[src]

pub fn emit_by_name_with_values<'a, N>(
    &self, 
    signal_name: N, 
    args: &[Value]
) -> Result<Option<Value>, BoolError> where
    N: Into<&'a str>,

Same as emit_by_name but takes Value for the arguments.

[src]

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

Same as emit_with_details but takes Value for the arguments.

[src]

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

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

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

[src]

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

[src]

impl<T> ToSendValue for T where
    T: Send + ToValue + ?Sized,

[src]

pub fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.

[src]

impl<T> ToString for T where
    T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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.

[src]

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

Performs the conversion.

[src]

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

[src]

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