Struct VectorSprite 

pub struct VectorSprite { /* private fields */ }

A sprite used to draw textures or icons.

Symbolic icons

If a sprite is created from a gtk::SymbolicPaintable source, such as a symbolic icon, then when the sprite is part of a symbol layer it will be drawn using the icon-color property (or the text color, if the sprite is part of a formatted string).

Properties

height

The height at which the sprite should be drawn, in pixels.

Readable | Writable | Construct Only

scale-factor

The intended scale factor of the sprite.

Readable | Writable | Construct Only

source-paintable

The [gdk::Paintable][crate::gdk::Paintable] used to draw the sprite.

Readable | Writable | Construct Only

source-rect

The area of the source rectangle to draw, or None to use the entire paintable.

Readable | Writable | Construct Only

width

The width at which the sprite should be drawn, in pixels.

Readable | Writable | Construct Only

Implements

[trait@glib::ObjectExt], gdk::prelude::PaintableExt, gtk::prelude::SymbolicPaintableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl VectorSprite

pub fn new(source_paintable: &impl IsA<Paintable>) -> VectorSprite

Creates a new VectorSprite using the paintable’s intrinsic size.

source_paintable

a [gdk::Paintable][crate::gdk::Paintable]

pub fn new_full( source_paintable: &impl IsA<Paintable>, width: i32, height: i32, scale_factor: f64, source_rect: Option<&Rectangle>, ) -> VectorSprite

Creates a new VectorSprite with the given size, scale factor, and area of the source paintable.

source_paintable

a [gdk::Paintable][crate::gdk::Paintable]

width

the width of the sprite in pixels

height

the height of the sprite in pixels

scale_factor

the intended scale factor of the sprite

source_rect

the source rectangle of the sprite, or None to use the entire paintable

pub fn builder() -> VectorSpriteBuilder

Creates a new builder-pattern struct instance to construct VectorSprite objects.

This method returns an instance of VectorSpriteBuilder which can be used to create VectorSprite objects.

pub fn height(&self) -> i32

Gets the height at which the sprite should be drawn.

Returns

the sprite’s height in pixels

pub fn scale_factor(&self) -> f64

Gets the intended scale factor of the sprite.

Returns

the sprite’s scale factor

pub fn source_paintable(&self) -> Option<Paintable>

Gets the source [gdk::Paintable][crate::gdk::Paintable] used to draw the sprite.

Note that VectorSprite also implements [gdk::Paintable][crate::gdk::Paintable]. In most cases, you should draw the sprite rather than the original paintable.

Returns

the source paintable

pub fn source_rect(&self) -> Option<Rectangle>

Gets the source rectangle of the sprite.

Returns

the sprite’s source rectangle, or None if the entire paintable is used

pub fn width(&self) -> i32

Gets the width at which the sprite should be drawn.

Returns

the sprite’s width in pixels

Trait Implementations

impl Clone for VectorSprite

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl Debug for VectorSprite

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

Formats the value using the given formatter.

impl Default for VectorSprite

Available on crate feature v1_1 only.

fn default() -> Self

Returns the “default value” for a type.

impl Eq for VectorSprite

impl HasParamSpec for VectorSprite

type ParamSpec = ParamSpecObject

type SetValue = VectorSprite

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, VectorSprite>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for VectorSprite

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

where H: Hasher,

Hashes the memory address of this object.

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 IsA<Paintable> for VectorSprite

impl IsA<SymbolicPaintable> for VectorSprite

impl Ord for VectorSprite

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 ParentClassIs for VectorSprite

type Parent = Object

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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<OT: ObjectType> PartialOrd<OT> for VectorSprite

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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 VectorSprite

fn static_type() -> Type

Returns the type identifier of Self.