Struct rute::auto::icon::Icon

source ·

pub struct Icon<'a> { /* private fields */ }

Expand description

Notice these docs are heavy WIP and not very relevent yet

A QIcon can generate smaller, larger, active, and disabled pixmaps from the set of pixmaps it is given. Such pixmaps are used by Qt widgets to show an icon representing a particular action.

The simplest use of QIcon is to create one from a QPixmap file or resource, and then use it, allowing Qt to work out all the required icon styles and sizes. For example:

To undo a QIcon, simply set a null icon in its place:

Use the QImageReader::supportedImageFormats() and QImageWriter::supportedImageFormats() functions to retrieve a complete list of the supported file formats.

When you retrieve a pixmap using pixmap(QSize, Mode, State), and no pixmap for this given size, mode and state has been added with addFile() or addPixmap(), then QIcon will generate one on the fly. This pixmap generation happens in a QIconEngine. The default engine scales pixmaps down if required, but never up, and it uses the current style to calculate a disabled appearance. By using custom icon engines, you can customize every aspect of generated icons. With QIconEnginePlugin it is possible to register different icon engines for different file suffixes, making it possible for third parties to provide additional icon engines to those included with Qt.

Note: Since Qt 4.2, an icon engine that supports SVG is included.

Making Classes that Use QIcon

If you write your own widgets that have an option to set a small pixmap, consider allowing a QIcon to be set for that pixmap. The Qt class QToolButton is an example of such a widget.

Provide a method to set a QIcon, and when you draw the icon, choose whichever pixmap is appropriate for the current state of your widget. For example:

You might also make use of the Active mode, perhaps making your widget Active when the mouse is over the widget (see QWidget::enterEvent()),,) while the mouse is pressed pending the release that will activate the function, or when it is the currently selected item. If the widget can be toggled, the mode might be used to draw a different icon.

Note: QIcon needs a QGuiApplication instance before the icon is created.

High DPI Icons

There are two ways that QIcon supports high DPI

icons: via addFile() and fromTheme().

addFile() is useful if you have your own custom directory structure and do not need to use the freedesktop.org Icon Theme Specification . Icons created via this approach use Qt’s “@nx” high DPI syntax

Using fromTheme() is necessary if you plan on following the Icon Theme Specification. To make QIcon use the high DPI version of an image, add an additional entry to the appropriate index.theme file:

Your icon theme directory would then look something like this:

See also: {fowler}{GUI Design Handbook: Iconic Label} {Icons Example}

Licence

The documentation is an adoption of the original Qt Documentation and provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.

Struct rute::auto::icon::Icon

Implementations

impl<'a> Icon<'a>

pub fn new() -> Icon<'a>

pub fn swap<I: IconTrait<'a>>(&self, other: &I) -> &Self

pub fn pixmap<S: SizeTrait<'a>>( &self, size: &S, mode: Mode, state: State) -> Pixmap<'_>

pub fn pixmap_2(&self, w: i32, h: i32, mode: Mode, state: State) -> Pixmap<'_>

pub fn pixmap_3(&self, extent: i32, mode: Mode, state: State) -> Pixmap<'_>

pub fn pixmap_4<S: SizeTrait<'a>, W: WindowTrait<'a>>( &self, window: &W, size: &S, mode: Mode, state: State) -> Pixmap<'_>

pub fn actual_size<S: SizeTrait<'a>>( &self, size: &S, mode: Mode, state: State) -> Size<'_>

pub fn actual_size_2<S: SizeTrait<'a>, W: WindowTrait<'a>>( &self, window: &W, size: &S, mode: Mode, state: State) -> Size<'_>

pub fn name(&self) -> String

pub fn paint<P: PainterTrait<'a>, R: RectTrait<'a>>( &self, painter: &P, rect: &R, alignment: Alignment, mode: Mode, state: State) -> &Self

pub fn paint_2<P: PainterTrait<'a>>( &self, painter: &P, x: i32, y: i32, w: i32, h: i32, alignment: Alignment, mode: Mode, state: State) -> &Self

pub fn is_null(&self) -> bool

pub fn is_detached(&self) -> bool

pub fn detach(&self) -> &Self

pub fn cache_key(&self) -> i64

pub fn add_pixmap<P: PixmapTrait<'a>>( &self, pixmap: &P, mode: Mode, state: State) -> &Self

pub fn add_file<S: SizeTrait<'a>>( &self, file_name: &str, size: &S, mode: Mode, state: State) -> &Self

pub fn set_is_mask(&self, is_mask: bool) -> &Self

pub fn is_mask(&self) -> bool

pub fn from_theme(name: &str) -> Icon<'a>

pub fn from_theme_2<I: IconTrait<'a>>(name: &str, fallback: &I) -> Icon<'a>

pub fn has_theme_icon(name: &str) -> bool

pub fn theme_name() -> String

pub fn set_theme_name(path: &str)

pub fn build(&self) -> Self

Trait Implementations

impl<'a> Clone for Icon<'a>

fn clone(&self) -> Icon<'a>

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

impl<'a> IconTrait<'a> for Icon<'a>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Icon<'a>

impl<'a> !Send for Icon<'a>

impl<'a> !Sync for Icon<'a>

impl<'a> Unpin for Icon<'a>

impl<'a> !UnwindSafe for Icon<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

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

pub fn pixmap<S: SizeTrait<'a>>(
&self,
size: &S,
mode: Mode,
state: State
) -> Pixmap<'_>

pub fn pixmap_4<S: SizeTrait<'a>, W: WindowTrait<'a>>(
&self,
window: &W,
size: &S,
mode: Mode,
state: State
) -> Pixmap<'_>

pub fn actual_size<S: SizeTrait<'a>>(
&self,
size: &S,
mode: Mode,
state: State
) -> Size<'_>

pub fn actual_size_2<S: SizeTrait<'a>, W: WindowTrait<'a>>(
&self,
window: &W,
size: &S,
mode: Mode,
state: State
) -> Size<'_>

pub fn paint<P: PainterTrait<'a>, R: RectTrait<'a>>(
&self,
painter: &P,
rect: &R,
alignment: Alignment,
mode: Mode,
state: State
) -> &Self

pub fn paint_2<P: PainterTrait<'a>>(
&self,
painter: &P,
x: i32,
y: i32,
w: i32,
h: i32,
alignment: Alignment,
mode: Mode,
state: State
) -> &Self

pub fn add_pixmap<P: PixmapTrait<'a>>(
&self,
pixmap: &P,
mode: Mode,
state: State
) -> &Self

pub fn add_file<S: SizeTrait<'a>>(
&self,
file_name: &str,
size: &S,
mode: Mode,
state: State
) -> &Self

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

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

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

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

impl<T> ToOwned for Twhere
T: Clone,

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

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,