Struct gtk::IconInfo [−][src]
pub struct IconInfo(_);
Expand description
Implementations
Creates a IconInfo for a gdk_pixbuf::Pixbuf.
icon_theme
pixbuf
the pixbuf to wrap in a IconInfo
Returns
a IconInfo
Gets the base scale for the icon. The base scale is a scale for the icon that was specified by the icon theme creator. For instance an icon drawn for a high-dpi screen with window scale 2 for a base size of 32 will be 64 pixels tall and have a base scale of 2.
Returns
the base scale
Gets the base size for the icon. The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.
Note that for scaled icons the base size does not include the base scale.
Returns
the base size, or 0, if no base size is known for the icon.
Gets the filename for the icon. If the IconLookupFlags::USE_BUILTIN
flag was passed to IconThemeExt::lookup_icon(), there may be no
filename if a builtin icon is returned; in this case, you should
use gtk_icon_info_get_builtin_pixbuf().
Returns
the filename for the icon, or None
if gtk_icon_info_get_builtin_pixbuf() should be used instead.
The return value is owned by GTK+ and should not be modified
or freed.
Renders an icon previously looked up in an icon theme using
IconThemeExt::lookup_icon(); the size will be based on the size
passed to IconThemeExt::lookup_icon(). Note that the resulting
pixbuf may not be exactly this size; an icon theme may have icons
that differ slightly from their nominal sizes, and in addition GTK+
will avoid scaling icons that it considers sufficiently close to the
requested size or for which the source image would have to be scaled
up too far. (This maintains sharpness.). This behaviour can be changed
by passing the IconLookupFlags::FORCE_SIZE flag when obtaining
the IconInfo. If this flag has been specified, the pixbuf
returned by this function will be scaled to the exact size.
Returns
the rendered icon; this may be a newly
created icon or a new reference to an internal icon, so you must
not modify the icon. Use g_object_unref() to release your reference
to the icon.
Asynchronously load, render and scale an icon previously looked up
from the icon theme using IconThemeExt::lookup_icon().
For more details, see load_icon() which is the synchronous
version of this call.
cancellable
optional gio::Cancellable object, None to ignore
callback
a GAsyncReadyCallback to call when the
request is satisfied
pub fn load_icon_async_future(
&self
) -> Pin<Box_<dyn Future<Output = Result<Pixbuf, Error>> + 'static>>Renders an icon previously looked up in an icon theme using
IconThemeExt::lookup_icon(); the size will be based on the size
passed to IconThemeExt::lookup_icon(). Note that the resulting
surface may not be exactly this size; an icon theme may have icons
that differ slightly from their nominal sizes, and in addition GTK+
will avoid scaling icons that it considers sufficiently close to the
requested size or for which the source image would have to be scaled
up too far. (This maintains sharpness.). This behaviour can be changed
by passing the IconLookupFlags::FORCE_SIZE flag when obtaining
the IconInfo. If this flag has been specified, the pixbuf
returned by this function will be scaled to the exact size.
for_window
gdk::Window to optimize drawing for, or None
Returns
the rendered icon; this may be a newly
created icon or a new reference to an internal icon, so you must
not modify the icon. Use cairo_surface_destroy() to release your
reference to the icon.
Loads an icon, modifying it to match the system colours for the foreground,
success, warning and error colors provided. If the icon is not a symbolic
one, the function will return the result from load_icon().
This allows loading symbolic icons that will match the system theme.
Unless you are implementing a widget, you will want to use
g_themed_icon_new_with_default_fallbacks() to load the icon.
As implementation details, the icon loaded needs to be of SVG type, contain the “symbolic” term as the last component of the icon name, and use the “fg”, “success”, “warning” and “error” CSS styles in the SVG file itself.
See the Symbolic Icons Specification for more information about symbolic icons.
fg
a gdk::RGBA representing the foreground color of the icon
success_color
a gdk::RGBA representing the warning color
of the icon or None to use the default color
warning_color
a gdk::RGBA representing the warning color
of the icon or None to use the default color
error_color
a gdk::RGBA representing the error color
of the icon or None to use the default color (allow-none)
Returns
a gdk_pixbuf::Pixbuf representing the loaded icon
was_symbolic
a gboolean, returns whether the
loaded icon was a symbolic one and whether the fg color was
applied to it.
Asynchronously load, render and scale a symbolic icon previously looked up
from the icon theme using IconThemeExt::lookup_icon().
For more details, see load_symbolic() which is the synchronous
version of this call.
fg
a gdk::RGBA representing the foreground color of the icon
success_color
a gdk::RGBA representing the warning color
of the icon or None to use the default color
warning_color
a gdk::RGBA representing the warning color
of the icon or None to use the default color
error_color
a gdk::RGBA representing the error color
of the icon or None to use the default color (allow-none)
cancellable
optional gio::Cancellable object,
None to ignore
callback
a GAsyncReadyCallback to call when the
request is satisfied
pub fn load_symbolic_async_future(
&self,
fg: &RGBA,
success_color: Option<&RGBA>,
warning_color: Option<&RGBA>,
error_color: Option<&RGBA>
) -> Pin<Box_<dyn Future<Output = Result<(Pixbuf, bool), Error>> + 'static>>Loads an icon, modifying it to match the system colors for the foreground,
success, warning and error colors provided. If the icon is not a symbolic
one, the function will return the result from load_icon().
This function uses the regular foreground color and the symbolic colors
with the names “success_color”, “warning_color” and “error_color” from
the context.
This allows loading symbolic icons that will match the system theme.
See load_symbolic() for more details.
context
Returns
a gdk_pixbuf::Pixbuf representing the loaded icon
was_symbolic
a gboolean, returns whether the
loaded icon was a symbolic one and whether the fg color was
applied to it.
Asynchronously load, render and scale a symbolic icon previously
looked up from the icon theme using IconThemeExt::lookup_icon().
For more details, see load_symbolic_for_context()
which is the synchronous version of this call.
context
cancellable
optional gio::Cancellable object,
None to ignore
callback
a GAsyncReadyCallback to call when the
request is satisfied
Trait Implementations
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
Returns the type identifier of Self.
Auto Trait Implementations
impl RefUnwindSafe for IconInfoimpl UnwindSafe for IconInfoBlanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
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
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
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more
Returns true if the object is an instance of (can be cast to) T.
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>, pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>, Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync, pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec), pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec), pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>, pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>, 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>, Same as connect but takes a SignalId instead of a signal name.
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>, Same as connect_local but takes a SignalId instead of a signal name.
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>, Same as connect_unsafe but takes a SignalId instead of a signal name.
Emit signal by signal id.
Emit signal with details by signal id.
Emit signal by it’s name.
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>, Same as emit but takes Value for the arguments.
Same as emit_by_name but takes Value for the arguments.
Returns a SendValue clone of self.
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>,