| Maintainer | gtk2hs-users@lists.sourceforge.net |
|---|---|
| Stability | provisional |
| Portability | portable (depends on GHC) |
| Safe Haskell | None |
| Language | Haskell98 |
Graphics.UI.Gtk.Builder
Description
Build an interface from an XML UI definition
All functions in this module are only available in Gtk 2.12 or higher.
- data Builder
- class ObjectClass o => BuilderClass o
- castToBuilder :: GObjectClass obj => obj -> Builder
- gTypeBuilder :: GType
- toBuilder :: BuilderClass o => o -> Builder
- data BuilderError
- builderNew :: IO Builder
- builderAddFromFile :: GlibFilePath fp => Builder -> fp -> IO ()
- builderAddFromString :: GlibString string => Builder -> string -> IO ()
- builderAddObjectsFromFile :: (GlibString string, GlibFilePath fp) => Builder -> fp -> [string] -> IO ()
- builderAddObjectsFromString :: GlibString string => Builder -> string -> [string] -> IO ()
- builderGetObject :: (GObjectClass cls, GlibString string) => Builder -> (GObject -> cls) -> string -> IO cls
- builderGetObjects :: Builder -> IO [GObject]
- builderGetObjectRaw :: GlibString string => Builder -> string -> IO (Maybe GObject)
- builderSetTranslationDomain :: GlibString string => Builder -> Maybe string -> IO ()
- builderGetTranslationDomain :: GlibString string => Builder -> IO (Maybe string)
Detail
Class Hierarchy
|GObject| +----GtkBuilder
Types
class ObjectClass o => BuilderClass o Source
Instances
castToBuilder :: GObjectClass obj => obj -> Builder Source
toBuilder :: BuilderClass o => o -> Builder Source
data BuilderError Source
Constructors
Instances
Constructing and adding objects
builderNew :: IO Builder Source
Creates a new Builder object.
builderAddFromFile :: GlibFilePath fp => Builder -> fp -> IO () Source
Parses a file containing a GtkBuilder UI definition and merges it with
the current contents of the Builder.
- If an error occurs, the computation will throw an exception that can
be caught using e.g.
catchGErrorJustand one of the error codes inBuilderError.
builderAddFromString :: GlibString string => Builder -> string -> IO () Source
Parses a string containing a GtkBuilder UI definition and merges it
with the current contents of the Builder.
- If an error occurs, the computation will throw an exception that can
be caught using e.g.
catchGErrorJustand one of the error codes inBuilderError.
builderAddObjectsFromFile Source
Arguments
| :: (GlibString string, GlibFilePath fp) | |
| => Builder | |
| -> fp | |
| -> [string] | Object IDs |
| -> IO () |
Parses a file containing a GtkBuilder UI definition building only
the requested objects and merges them with the current contents of
the Builder.
- If an error occurs, the computation will throw an exception that can
be caught using e.g.
catchGErrorJustand one of the error codes inBuilderError.
builderAddObjectsFromString Source
Arguments
| :: GlibString string | |
| => Builder | |
| -> string | |
| -> [string] | Object IDs |
| -> IO () |
Parses a string containing a GtkBuilder UI definition building only
the requested objects and merges them with the current contents of
the Builder.
- If an error occurs, the computation will throw an exception that can
be caught using e.g.
catchGErrorJustand one of the error codes inBuilderError.
Retrieving objects
Arguments
| :: (GObjectClass cls, GlibString string) | |
| => Builder | |
| -> (GObject -> cls) | A dynamic cast function which returns an object
of the expected type, eg |
| -> string | |
| -> IO cls |
Gets the object with the given name, with a conversion function. Note that this computation does not increment the reference count of the returned object.
If the object with the given ID is not of the requested type, an exception will be thrown.
builderGetObjects :: Builder -> IO [GObject] Source
Gets all objects that have been constructed by builder. Note that this computation does not increment the reference counts of the returned objects.
builderGetObjectRaw :: GlibString string => Builder -> string -> IO (Maybe GObject) Source
Gets the object with the given name. Note that this computation does not increment the reference count of the returned object.
builderSetTranslationDomain :: GlibString string => Builder -> Maybe string -> IO () Source
Sets the translation domain of the Builder.
builderGetTranslationDomain :: GlibString string => Builder -> IO (Maybe string) Source
Gets the translation domain of the Builder.