|
Graphics.UI.Gtk.General.IconFactory | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
Description |
Manipulating stock icons
|
|
Synopsis |
|
|
|
|
Detail
|
|
Browse the available stock icons in the list of stock IDs found here. You
can also use the gtk-demo application for this purpose.
An icon factory manages a collection of IconSet; a IconSet manages a
set of variants of a particular icon (i.e. a IconSet contains variants for
different sizes and widget states). Icons in an icon factory are named by a
stock ID, which is a simple string identifying the icon. Each Style has a
list of IconFactory derived from the current theme; those icon factories
are consulted first when searching for an icon. If the theme doesn't set a
particular icon, Gtk+ looks for the icon in a list of default icon
factories, maintained by iconFactoryAddDefault and
iconFactoryRemoveDefault. Applications with icons should add a default
icon factory with their icons, which will allow themes to override the icons
for the application.
To display an icon, always use
Graphics.UI.Gtk.General.Style.styleLookupIconSet on the widget that
will display the icon, or the convenience function
Graphics.UI.Gtk.Abstract.Widget.widgetRenderIcon. These
functions take the theme into account when looking up the icon to use for a
given stock ID.
|
|
Class Hierarchy
|
|
| GObject
| +----IconFactory
|
|
Types
|
|
|
Instances | |
|
|
|
| Instances | |
|
|
|
|
|
|
|
|
Constructors
|
|
|
Create a new IconFactory.
- An application should create a new IconFactory and add all
needed icons.
By calling iconFactoryAddDefault these icons become
available as stock objects and can easily be displayed by
Image. Furthermore, a theme can override the icons defined by
the application.
|
|
Methods
|
|
|
Add an IconSet to an IconFactory.
In order to use the new stock object, the factory as to be added to the
default factories by iconFactoryAddDefault.
|
|
|
Add all entries of the IconFactory to the
applications stock object database.
|
|
|
Looks up the stock id in the icon factory, returning an icon set if found,
otherwise Nothing.
For display to the user, you should use
Graphics.UI.Gtk.General.Style.styleLookupIconSet on the
Graphics.UI.Gtk.General.Style.Style
for the widget that will display the icon, instead of using this function
directly, so that themes are taken into account.
|
|
|
Looks for an icon in the list of default icon factories.
For display to the user, you should use
Graphics.UI.Gtk.General.Style.styleLookupIconSet on the
Graphics.UI.Gtk.General.Style.Style
for the widget that will display the icon, instead of using this function
directly, so that themes are taken into account.
|
|
|
Remove an IconFactory from the
application's stock database.
|
|
|
|
|
Create a new IconSet.
- Each icon in an application is contained in an IconSet. The
IconSet contains several variants (IconSources) to
accomodate for different sizes and states.
|
|
|
Creates a new IconSet with the given pixbuf as the default/fallback
source image. If you don't add any additional IconSource to the icon set,
all variants of the icon will be created from the pixbuf, using scaling,
pixelation, etc. as required to adjust the icon size or make the icon look
insensitive/prelighted.
|
|
|
Add an IconSource (an Icon with
attributes) to an IconSet.
- If an icon is looked up in the IconSet set the best matching
IconSource will be taken. It is therefore advisable to add a default
(wildcarded) icon, than can be used if no exact match is found.
|
|
|
|
|
Obtains a list of icon sizes this icon set can render.
|
|
|
|
|
Create a new IconSource.
- An IconSource is a single image that is usually added to an IconSet. Next
to the image it contains information about which state, text direction
and size it should apply.
|
|
|
Constructors | TextDirNone | | TextDirLtr | | TextDirRtl | |
| Instances | |
|
|
|
Retrieve the TextDirection of
this IconSource.
- Nothing is returned if no explicit direction was set.
|
|
|
Mark this IconSource that it
should only apply to the specified TextDirection.
|
|
|
Reset the specific
TextDirection set with iconSourceSetDirection.
|
|
|
Retrieve the filename this IconSource was
based on.
- Returns Nothing if the IconSource was generated by a Pixbuf.
|
|
|
Load an icon picture from this filename.
|
|
|
Retrieves the source pixbuf, or Nothing if none is set.
|
|
|
Sets a pixbuf to use as a base image when creating icon variants for
IconSet.
|
|
|
Retrieve the IconSize of this
IconSource.
- Nothing is returned if no explicit size was set (i.e. this
IconSource matches all sizes).
|
|
|
Set this IconSource to a specific
size.
|
|
|
Reset the IconSize of this
IconSource so that is matches anything.
|
|
|
Widget states
| Constructors | StateNormal | | StateActive | | StatePrelight | | StateSelected | | StateInsensitive | |
| Instances | |
|
|
|
Retrieve the StateType of this
IconSource.
- Nothing is returned if the IconSource matches all
states.
|
|
|
Mark this icon to be used only with this
specific state.
|
|
|
Reset the StateType of this
IconSource so that is matches anything.
|
|
|
The size of an icon in pixels.
- This enumeration contains one case that is not exported and which
is used when new sizes are registered using
Graphics.UI.Gtk.General.IconFactory.iconSizeRegister.
- Applying show to this type will reveal the name of the size
that is registered with Gtk+.
| Constructors | IconSizeInvalid | Don't scale but use any of the available sizes.
| IconSizeMenu | Icon size to use in next to menu items in drop-down menus.
| IconSizeSmallToolbar | Icon size for small toolbars.
| IconSizeLargeToolbar | Icon size for larger toolbars.
| IconSizeButton | Icon size for icons in buttons, next to the label.
| IconSizeDnd | Icon size for icons in drag-and-drop.
| IconSizeDialog | Icon size for icons next to dialog text.
| IconSizeUser Int | |
| Instances | |
|
|
|
Check if a given IconSize is registered.
- Useful if your application expects a theme to install a set with a
specific size. You can test if this actually happend and use another size
if not.
|
|
|
:: String | the new name of the size
| -> Int | the width of the icon
| -> Int | the height of the icon
| -> IO IconSize | the new icon size
| Register a new IconSize.
|
|
|
|
Register an additional alias for a name.
|
|
|
Lookup an IconSize by name.
- This fixed value iconSizeInvalid is returned if the name was
not found.
|
|
|
Lookup the name of an IconSize.
- Returns Nothing if the name was not found.
|
|
Produced by Haddock version 2.6.1 |