Graphics.UI.Gtk.General.IconFactory

gtk3-0.14.5: Binding to the Gtk+ 3 graphical user interface library

Maintainer | gtk2hs-users@lists.sourceforge.net
Stability | provisional
Portability | portable (depends on GHC)
Safe Haskell | None
Language | Haskell98

Graphics.UI.Gtk.General.IconFactory

Contents

- Detail
- Class Hierarchy
- Types
- Constructors
- Methods
- Orphan instances

Description

Manipulating stock icons

Synopsis

- data IconFactory
- class GObjectClass o => IconFactoryClass o
- castToIconFactory :: GObjectClass obj => obj -> IconFactory
- gTypeIconFactory :: GType
- toIconFactory :: IconFactoryClass o => o -> IconFactory
- iconFactoryNew :: IO IconFactory
- iconFactoryAdd :: IconFactory -> StockId -> IconSet -> IO ()
- iconFactoryAddDefault :: IconFactory -> IO ()
- iconFactoryLookup :: IconFactory -> StockId -> IO (Maybe IconSet)
- iconFactoryLookupDefault :: StockId -> IO (Maybe IconSet)
- iconFactoryRemoveDefault :: IconFactory -> IO ()
- data IconSet
- iconSetNew :: IO IconSet
- iconSetNewFromPixbuf :: Pixbuf -> IO IconSet
- iconSetAddSource :: IconSet -> IconSource -> IO ()
- iconSetRenderIcon :: WidgetClass widget => IconSet -> TextDirection -> StateType -> IconSize -> widget -> IO Pixbuf
- iconSetGetSizes :: IconSet -> IO [IconSize]
- data IconSource
- iconSourceNew :: IO IconSource
- data TextDirection
  - = TextDirNone
  - | TextDirLtr
  - | TextDirRtl
- iconSourceGetDirection :: IconSource -> IO (Maybe TextDirection)
- iconSourceSetDirection :: IconSource -> TextDirection -> IO ()
- iconSourceResetDirection :: IconSource -> IO ()
- iconSourceGetFilename :: GlibString string => IconSource -> IO (Maybe string)
- iconSourceSetFilename :: GlibFilePath fp => IconSource -> fp -> IO ()
- iconSourceGetPixbuf :: IconSource -> IO (Maybe Pixbuf)
- iconSourceSetPixbuf :: IconSource -> Pixbuf -> IO ()
- iconSourceGetSize :: IconSource -> IO (Maybe IconSize)
- iconSourceSetSize :: IconSource -> IconSize -> IO ()
- iconSourceResetSize :: IconSource -> IO ()
- data StateType
  - = StateNormal
  - | StateActive
  - | StatePrelight
  - | StateSelected
  - | StateInsensitive
  - | StateInconsistent
  - | StateFocused
- iconSourceGetState :: IconSource -> IO (Maybe StateType)
- iconSourceSetState :: IconSource -> StateType -> IO ()
- iconSourceResetState :: IconSource -> IO ()
- data IconSize
  - = IconSizeInvalid
  - | IconSizeMenu
  - | IconSizeSmallToolbar
  - | IconSizeLargeToolbar
  - | IconSizeButton
  - | IconSizeDnd
  - | IconSizeDialog
  - | IconSizeUser Int
- iconSizeCheck :: IconSize -> IO Bool
- iconSizeRegister :: GlibString string => string -> Int -> Int -> IO IconSize
- iconSizeRegisterAlias :: GlibString string => IconSize -> string -> IO ()
- iconSizeFromName :: GlibString string => string -> IO IconSize
- iconSizeGetName :: GlibString string => IconSize -> IO (Maybe string)

# 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 `styleLookupIconSet` on the widget that will display the icon, or the convenience function `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

data IconFactory #

Instances

Eq IconFactory # |
Methods (==) :: IconFactory -> IconFactory -> Bool # (/=) :: IconFactory -> IconFactory -> Bool #
Ord IconFactory # |
Methods compare :: IconFactory -> IconFactory -> Ordering # (<) :: IconFactory -> IconFactory -> Bool # (<=) :: IconFactory -> IconFactory -> Bool # (>) :: IconFactory -> IconFactory -> Bool # (>=) :: IconFactory -> IconFactory -> Bool # max :: IconFactory -> IconFactory -> IconFactory # min :: IconFactory -> IconFactory -> IconFactory #
GObjectClass IconFactory # |
Methods toGObject :: IconFactory -> GObject # unsafeCastGObject :: GObject -> IconFactory #
IconFactoryClass IconFactory # |

class GObjectClass o => IconFactoryClass o #

Instances

IconFactoryClass IconFactory # |

castToIconFactory :: GObjectClass obj => obj -> IconFactory #

gTypeIconFactory :: GType #

toIconFactory :: IconFactoryClass o => o -> IconFactory #

# Constructors

iconFactoryNew :: IO IconFactory #

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

iconFactoryAdd :: IconFactory -> StockId -> IconSet -> IO () #

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`.

iconFactoryAddDefault :: IconFactory -> IO () #

Add all entries of the IconFactory to the applications stock object database.

iconFactoryLookup :: IconFactory -> StockId -> IO (Maybe IconSet) #

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 `styleLookupIconSet` on the `Style` for the widget that will display the icon, instead of using this function directly, so that themes are taken into account.

iconFactoryLookupDefault :: StockId -> IO (Maybe IconSet) #

Looks for an icon in the list of default icon factories.

For display to the user, you should use `styleLookupIconSet` on the `Style` for the widget that will display the icon, instead of using this function directly, so that themes are taken into account.

iconFactoryRemoveDefault :: IconFactory -> IO () #

Remove an IconFactory from the application's stock database.

data IconSet #

iconSetNew :: IO IconSet #

Create a new IconSet.

- Each icon in an application is contained in an `IconSet`. The `IconSet` contains several variants (`IconSource`s) to accomodate for different sizes and states.

iconSetNewFromPixbuf :: Pixbuf -> IO IconSet #

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.

iconSetAddSource :: IconSet -> IconSource -> IO () #

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.

iconSetRenderIcon :: WidgetClass widget => IconSet -> TextDirection -> StateType -> IconSize -> widget -> IO Pixbuf #

iconSetGetSizes :: IconSet -> IO [IconSize] #

Obtains a list of icon sizes this icon set can render.

data IconSource #

iconSourceNew :: IO IconSource #

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.

data TextDirection #

Constructors

TextDirNone |
TextDirLtr |
TextDirRtl |

Instances

Enum TextDirection # |
Methods succ :: TextDirection -> TextDirection # pred :: TextDirection -> TextDirection # toEnum :: Int -> TextDirection # fromEnum :: TextDirection -> Int # enumFrom :: TextDirection -> [TextDirection] # enumFromThen :: TextDirection -> TextDirection -> [TextDirection] # enumFromTo :: TextDirection -> TextDirection -> [TextDirection] # enumFromThenTo :: TextDirection -> TextDirection -> TextDirection -> [TextDirection] #
Eq TextDirection # |
Methods (==) :: TextDirection -> TextDirection -> Bool # (/=) :: TextDirection -> TextDirection -> Bool #
Show TextDirection # |
Methods showsPrec :: Int -> TextDirection -> ShowS # show :: TextDirection -> String # showList :: [TextDirection] -> ShowS #

iconSourceGetDirection :: IconSource -> IO (Maybe TextDirection) #

Retrieve the `TextDirection` of this IconSource.

- `Nothing` is returned if no explicit direction was set.

iconSourceSetDirection :: IconSource -> TextDirection -> IO () #

Mark this `IconSource` that it should only apply to the specified `TextDirection`.

iconSourceResetDirection :: IconSource -> IO () #

Reset the specific `TextDirection` set with `iconSourceSetDirection`.

iconSourceGetFilename :: GlibString string => IconSource -> IO (Maybe string) #

Retrieve the filename this IconSource was based on.

- Returns `Nothing` if the IconSource was generated by a Pixbuf.

iconSourceSetFilename :: GlibFilePath fp => IconSource -> fp -> IO () #

Load an icon picture from this filename.

iconSourceGetPixbuf :: IconSource -> IO (Maybe Pixbuf) #

Retrieves the source pixbuf, or Nothing if none is set.

iconSourceSetPixbuf :: IconSource -> Pixbuf -> IO () #

Sets a pixbuf to use as a base image when creating icon variants for `IconSet`.

iconSourceGetSize :: IconSource -> IO (Maybe IconSize) #

Retrieve the `IconSize` of this IconSource.

- `Nothing` is returned if no explicit size was set (i.e. this `IconSource` matches all sizes).

iconSourceSetSize :: IconSource -> IconSize -> IO () #

Set this `IconSource` to a specific size.

iconSourceResetSize :: IconSource -> IO () #

Reset the `IconSize` of this `IconSource` so that is matches anything.

data StateType #

Widget states

Constructors

StateNormal |
StateActive |
StatePrelight |
StateSelected |
StateInsensitive |
StateInconsistent |
StateFocused |

Instances

Enum StateType # |
Methods succ :: StateType -> StateType # pred :: StateType -> StateType # toEnum :: Int -> StateType # fromEnum :: StateType -> Int # enumFrom :: StateType -> [StateType] # enumFromThen :: StateType -> StateType -> [StateType] # enumFromTo :: StateType -> StateType -> [StateType] # enumFromThenTo :: StateType -> StateType -> StateType -> [StateType] #
Eq StateType # |
Methods (==) :: StateType -> StateType -> Bool # (/=) :: StateType -> StateType -> Bool #
Show StateType # |
Methods showsPrec :: Int -> StateType -> ShowS # show :: StateType -> String # showList :: [StateType] -> ShowS #

iconSourceGetState :: IconSource -> IO (Maybe StateType) #

Retrieve the `StateType` of this `IconSource`.

- `Nothing` is returned if the `IconSource` matches all states.

iconSourceSetState :: IconSource -> StateType -> IO () #

Mark this icon to be used only with this specific state.

iconSourceResetState :: IconSource -> IO () #

Reset the `StateType` of this `IconSource` so that is matches anything.

data IconSize #

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 `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

Enum IconSize # |
Methods succ :: IconSize -> IconSize # pred :: IconSize -> IconSize # toEnum :: Int -> IconSize # fromEnum :: IconSize -> Int # enumFrom :: IconSize -> [IconSize] # enumFromThen :: IconSize -> IconSize -> [IconSize] # enumFromTo :: IconSize -> IconSize -> [IconSize] # enumFromThenTo :: IconSize -> IconSize -> IconSize -> [IconSize] #
Eq IconSize # |
Methods (==) :: IconSize -> IconSize -> Bool # (/=) :: IconSize -> IconSize -> Bool #

iconSizeCheck :: IconSize -> IO Bool #

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.

iconSizeRegister #

Arguments

:: GlibString string |
=> 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.

iconSizeRegisterAlias :: GlibString string => IconSize -> string -> IO () #

Register an additional alias for a name.

iconSizeFromName :: GlibString string => string -> IO IconSize #

Lookup an IconSize by name.

- This fixed value `iconSizeInvalid` is returned if the name was not found.

iconSizeGetName :: GlibString string => IconSize -> IO (Maybe string) #

Lookup the name of an IconSize.

- Returns `Nothing` if the name was not found.

# Orphan instances

Show IconSize # |
Methods showsPrec :: Int -> IconSize -> ShowS # show :: IconSize -> String # showList :: [IconSize] -> ShowS #