GI.Gio.Objects.ThemedIcon

ThemedIcon is an implementation of Icon that supports icon themes. ThemedIcon contains a list of all of the icons present in an icon theme, so that icons can be looked up quickly. ThemedIcon does not provide actual pixmaps for icons, just the icon names. Ideally something like gtk_icon_theme_choose_icon() should be used to resolve the list of names so that fallback icons work nicely with themes that inherit other themes.

Exported types

newtype ThemedIcon

Constructors

ThemedIcon (ManagedPtr ThemedIcon)

Instances

GObject ThemedIcon

Methods

gobjectType :: ThemedIcon -> IO GType

IsObject ThemedIcon

IsIcon ThemedIcon

IsThemedIcon ThemedIcon

class GObject o => IsThemedIcon o

Instances

(GObject a, UnknownAncestorError Constraint ThemedIcon a) => IsThemedIcon a

IsThemedIcon ThemedIcon

toThemedIcon :: (MonadIO m, IsThemedIcon o) => o -> m ThemedIcon

noThemedIcon :: Maybe ThemedIcon

Methods

appendName

themedIconAppendName

Arguments

:: (HasCallStack, MonadIO m, IsThemedIcon a)

=> a

icon: a ThemedIcon

-> Text

iconname: name of icon to append to list of icons from within icon.

-> m ()

Append a name to the list of icons from within icon.

Note that doing so invalidates the hash computed by prior calls to iconHash.

getNames

themedIconGetNames

Arguments

:: (HasCallStack, MonadIO m, IsThemedIcon a)

=> a

icon: a ThemedIcon.

-> m [Text]

Returns: a list of icon names.

Gets the names of icons from within icon.

new

themedIconNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

iconname: a string containing an icon name.

-> m ThemedIcon

Returns: a new ThemedIcon.

Creates a new themed icon for iconname.

newFromNames

themedIconNewFromNames

Arguments

:: (HasCallStack, MonadIO m)

=> [Text]

iconnames: an array of strings containing icon names.

-> m ThemedIcon

Returns: a new ThemedIcon

Creates a new themed icon for iconnames.

newWithDefaultFallbacks

themedIconNewWithDefaultFallbacks

Arguments

:: (HasCallStack, MonadIO m)

=> Text

iconname: a string containing an icon name

-> m ThemedIcon

Returns: a new ThemedIcon.

Creates a new themed icon for iconname, and all the names that can be created by shortening iconname at '-' characters.

In the following example, icon1 and icon2 are equivalent:

C code

const char *names[] = {
  "gnome-dev-cdrom-audio",
  "gnome-dev-cdrom",
  "gnome-dev",
  "gnome"
};

icon1 = g_themed_icon_new_from_names (names, 4);
icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio");

prependName

themedIconPrependName

Arguments

:: (HasCallStack, MonadIO m, IsThemedIcon a)

=> a

icon: a ThemedIcon

-> Text

iconname: name of icon to prepend to list of icons from within icon.

-> m ()

Prepend a name to the list of icons from within icon.

Note that doing so invalidates the hash computed by prior calls to iconHash.

Since: 2.18

Properties

name

constructThemedIconName :: IsThemedIcon o => Text -> IO (GValueConstruct o)

names

constructThemedIconNames :: IsThemedIcon o => [Text] -> IO (GValueConstruct o)

getThemedIconNames :: (MonadIO m, IsThemedIcon o) => o -> m [Text]

useDefaultFallbacks

constructThemedIconUseDefaultFallbacks :: IsThemedIcon o => Bool -> IO (GValueConstruct o)

getThemedIconUseDefaultFallbacks :: (MonadIO m, IsThemedIcon o) => o -> m Bool