Gtk - Haskell API

Table of Contents

AccelLabel - This widget is a special version of Label. It displays an accelerator key next to the Label. The key name is not explicitly set but taken from the key that is associated with the activation of another widget.

Adjustment - An Adjustment object contains a value with maximum bounds and a step size. It is used to represent the value of a scoll bar and similar widgets.

Alignment -

AspectFrame - A frame that constrains its child to a particular aspect ratio.

Box - This abstract container class is instatiated by using HBox or VBox. It supplies all methods to add and remove children.

Button -

Calendar - This widget shows a calendar.

CellRenderer - A CellRenderer is an object that determines how the cell of a TreeView widget is displayed. Each TreeViewColumn has exactly one accociated CellRenderer. The data supply for a cell is contained in a TreeStore or a ListStore (both subclasses of TreeModel). Each CellRenderer may have several attributes. Each Attribute is associated with one column of the TreeModel database. Thus several columns of a TreeModel may be the supply for one TreeViewColumn.

CellRendererPixbuf -

CellRendererText - A CellRenderer which displays a single-line text.

CellRendererToggle -

CheckButton -

CheckMenuItem - This widget implements a MenuItem with a check next to it.

Combo - A Combo box is a text entry field with a drop down list of predefined alternatives.

Container - This abstract widget implements the basis for turning serveral widgets into one compound widget.

Datastructure -

Dialog - A dialog is a smaller window that is used to ask the user for input.

DrawWindow - A primitive window.

Drawable - Drawing primitives.

DrawingArea - A user-defined widget.

Entry - This widget lets the user enter a single line of text.

Enumerations - General enumeration types.

EventBox - This module adds CString-like functions that handle UTF8 strings. Furthermore it serves as an impedance matcher for different compiler versions. - DOCU - TODO

FileSel -

FileSelection -

Frame - This container adds a frame around its contents. This is useful to logically separate items in a dialog box.

GArrow - An Arrow pointing to one of the four cardinal direction.

GC - Graphics contexts.

GObject - * Implements the base GObject class to satisfy the type checker.

GType - This module implements only the necessities for the GTK binding.

GValue - This module implements only the necessities for the GTK binding.

General -

HBox - This is a special version of Box. This widget shows its child widgets in a horizontal line.

HPaned -

HScale - The user may enter a value by moving the handle on the scale.

HScrollbar - This widget provides a stand-alone scrollbar. All interesting functions can be found in Range, from which it is derived.

HSeparator - The HSeparator widget is a horizontal separator, used to group the widgets within a window. It displays a horizontal line with a shadow to make it appear sunken into the interface. This has nothing to do with a menu separator.

HandleBox - * This file reflects the Gtk object hierarchy in terms of Haskell classes. -

IconFactory - This module provides access to IconFactory, IconSet and IconSource. - DOCU - TODO The following functions are not bound: iconFactoryLookup, iconFactoryLookupDefault It is not a good idea to lookup an IconSet directly. If an Icon needs to be displayed it happends always in the context of a widget. The best practice is to get the widgets Style and call styleLookupIconSet.

Image - This widget displays an image.

ImageMenuItem - This widget implements a MenuItem with an image next to it

Keys - Gdk keyval functions.

Label -

Layout - A layout widget can hold several widgets at arbitrary positions.

ListStore - The database for simple (non-hierarchical) tables.

Markup - This module defines some helper functions for generating texts with embedded attributes.

Menu - A Menu is a vertically aligned set of options that can be selected. There are two kinds: Those that are part of a MenuBar and those that appear as a context menu (within the work space).

MenuBar -

MenuItem - This widget represents a singe menu item.

MenuShell - An abstract base class which provides the control of navigation through menu items.

Misc -

Notebook - This widget can display several pages of widgets. Each page can be selected by a tab at the top of the widget. It is useful in dialogs where a lot of information has to be displayed.

Object -

OptionMenu -

Paned - This abstract widget provides a division line with a handle that can be used by the user to divide the given space between two widgets. The two concrete implementations are HPaned and VPaned.

PangoLayout - Defines functions to extract data from a GList and to produce a GList from a list of pointers. The same for GSList.

PangoTypes - Define types used in Pango which are not derived from GObject.

Pixbuf - Pixbufs are bitmap images in memory.

Plug - Plug is a window that is to be attached to the window of another application. If you have managed to receive the XID from the inviting application you can construct the Plug and add your widgets to it.

ProgressBar - The ProgressBar provides a means for an application to keep the user patient while some time intensive task is going on.

RadioButton - A radio group is a set of check buttons where only one button can be checked.

RadioMenuItem -

Range - An abstract base class to handle widgets that represent some value range.

Region - A set of rectangles describing areas to be redrawn.

Rendering - Functions to run the rendering pipeline.

Scale - This is the abstract base class for HScale and VScale. It implements the management of an adjustable value.

Scrollbar - This is the abstract base class for HScrollbar and VScrollbar.

ScrolledWindow - ScrolledWindow is a container that adds scroll bars to its child. Some widgets have native scrolling support, in which case the scrolling action is performed by the child itself (e.g. a TreeView widget does this by only moving the table part and not the titles of a table). If a widget does not support native scrolling it can be put into a ScrolledWindow widget.

Separator - This widget is the base class for HSeparator and VSeparator.

Socket - This widget provides the possibility that other application display their widgets within this application.

SpinButton - A spin button provides the possiblity to enter a numeric value without using the keyboard.

StatusBar - GtkStatusbar -- report messages of minor importance to the user.

StockItems - A StockItem is a resource that is know throughout Gtk. Defining you own IconSets as StockItems will make it possible for Gtk to choose the most appropriate sizes and enables themes to override you built in icons. A couple of constants are defined here as well. They are useful in accessing Gtk's predefined items.

StoreValue - This module implements only the necessities for the GTK binding.

Structures -

Styles - Customization of widgets.

Table - The table widget is a container in which widgets can be aligned in cells.

TearoffMenuItem - A TearoffMenuItem is a special GtkMenuItem which is used to tear off and reattach its menu. When its menu is shown normally, the TearoffMenuItem is drawn as a dotted line indicating that the menu can be torn off. Activating it causes its menu to be torn off and displayed in its own window as a tearoff menu. When its menu is shown as a tearoff menu, the TearoffMenuItem is drawn as a dotted line which has a left pointing arrow graphic indicating that the tearoff menu can be reattached. Activating it will erase the tearoff menu window.

TextBuffer - This storage object holds text to be displayed by one or more TextView widgets.

TextIter - * An iterator is an abstract datatype representing a pointer into a TextBuffer.

TextMark -

TextTag -

TextTagTable -

TextView -

ToggleButton - A ToggleButton is the base class for all buttons that have an inherit state.

Toolbar - Toolbar: create bars of buttons and derived widget. Buttons, RadioButtons and ToggleButtons can be added by refering to stock images. Their size can be changed by calling toolbarSetIconSize. In contrast, normal widget cannot be added. Due to the bad interface of GtkToolbar Mnemonics of RadioButtons and ToggleButtons are not honored.

Tooltips - Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar. An individual tooltip belongs to a group of tooltips. A group is created with a call to tooltipsNew. Every tooltip in the group can then be turned off with a call to tooltipsDisable and enabled with tooltipsEnable. The length of time the user must keep the mouse over a widget before the tip is shown, can be altered with tooltipsSetDelay. This is set on a 'per group of tooltips' basis. To assign a tip to a particular widget, tooltipsSetTip is used.

TreeModel - A TreeModel is the abstract base class for TreeStore and ListStore. -

TreeModelSort - TreeModelSort is an aggregated class to TreeModel. It turns any object derived from TreeModel into a store that is sorted. - DOCU - TODO

TreeSelection - * A TreeSelection is a data type belonging to a TreeModel. As the name suggests it holds the current selection which can even be a multiple choice.

TreeStore -

TreeView - This widget constitutes the main widget for displaying lists and other structured data.

TreeViewColumn -

VBox - This is a special version of Box. This widget shows its child widgets in a vertical line.

VPaned -

VScale - The user may enter a value by moving the handle on the scale.

VScrollbar - This widget provides a stand-alone scrollbar. All interesting functions can be found in Range, from which it is derived.

VSeparator - The VSeparator widget is a horizontal separator, used to group the widgets within a window. It displays a horizontal line with a shadow to make it appear sunken into the interface. This has nothing to do with a menu separator.

Viewport - A Viewport a helper widget that adds Adjustment slots to a widget, i.e. the widget becomes scrollable. It can then be put into ScrolledWindow and will behave as expected.

Widget - * Widget is the base class of all widgets. It provides the methods to attach and detach signals.

Window -