|
|
|
|
|
| Description |
ToolItem is the base class of widgets that can be added to Toolbar.
ToolItems are widgets that can appear on a toolbar.
- For toolbar items that contain buttons, see the ToolButton,
ToggleToolButton and RadioToolButton widgets.
- To create a toolbar item that contain something else than a button, use
toolItemNew. Use containerAdd to add a child widget to the tool item.
See the Toolbar for a description of the toolbar widget.
|
|
| Synopsis |
|
|
|
| Documentation |
|
| toolItemNew :: IO ToolItem |
| Creates a new ToolItem.
|
|
| toolItemSetHomogeneous :: ToolItemClass item => item -> Bool -> IO () |
| Sets whether the tool item is to be allocated the same size as other
homogeneous items. The effect is that all homogeneous items will have the
same width as the widest of the items.
|
|
| toolItemGetHomogeneous :: ToolItemClass item => item -> IO Bool |
| Returns whether the tool item is the same size as other homogeneous items.
|
|
| toolItemSetExpand :: ToolItemClass item => item -> Bool -> IO () |
| Sets whether the tool item is allocated extra space when there is more room
on the toolbar then needed for the items. The effect is that the item gets
bigger when the toolbar gets bigger and smaller when the toolbar gets
smaller.
|
|
| toolItemGetExpand :: ToolItemClass item => item -> IO Bool |
| Returns whether the tool item is allocated extra space.
|
|
| toolItemSetTooltip |
| :: ToolItemClass item | | | => item | | | -> Tooltips | | | -> String | | | -> String | | | -> IO () | | | Sets the Tooltips object to be used for the tool item, the text to be
displayed as tooltip on the item and the private text to be used. See
tooltipsSetTip.
|
|
|
| toolItemSetUseDragWindow :: ToolItemClass item => item -> Bool -> IO () |
| Sets whether toolitem has a drag window. When True the tool item can be
used as a drag source through dragSourceSet. When the tool item has a drag
window it will intercept all events, even those that would otherwise be sent
to a child widget.
|
|
| toolItemGetUseDragWindow :: ToolItemClass item => item -> IO Bool |
| Returns whether the tool item has a drag window. See
toolItemSetUseDragWindow.
|
|
| toolItemSetVisibleHorizontal :: ToolItemClass item => item -> Bool -> IO () |
| Sets whether the tool item is visible when the toolbar is docked
horizontally.
|
|
| toolItemGetVisibleHorizontal :: ToolItemClass item => item -> IO Bool |
| Returns whether the tool item is visible on toolbars that are docked
horizontally.
|
|
| toolItemSetVisibleVertical :: ToolItemClass item => item -> Bool -> IO () |
| Sets whether the tool item is visible when the toolbar is docked
vertically. Some tool items, such as text entries, are too wide to be useful
on a vertically docked toolbar. If False the tool item will not appear on
toolbars that are docked vertically.
|
|
| toolItemGetVisibleVertical :: ToolItemClass item => item -> IO Bool |
| Returns whether the tool item is visible when the toolbar is docked
vertically.
|
|
| toolItemSetIsImportant :: ToolItemClass item => item -> Bool -> IO () |
| Sets whether the tool item should be considered important. The ToolButton
class uses this property to determine whether to show or hide its label when
the toolbar style is ToolbarBothHoriz. The result is that only tool buttons
with the "is important" property set have labels, an effect known as
"priority text".
|
|
| toolItemGetIsImportant :: ToolItemClass item => item -> IO Bool |
| Returns whether the tool item is considered important.
|
|
| type IconSize = Int |
|
| toolItemGetIconSize :: ToolItemClass item => item -> IO IconSize |
| Returns the icon size used for the tool item.
|
|
| data Orientation |
| orientation is good
| | Constructors | | OrientationHorizontal | | | OrientationVertical | |
| | Instances | |
|
|
| toolItemGetOrientation :: ToolItemClass item => item -> IO Orientation |
| Returns the orientation used for the tool item.
|
|
| data ToolbarStyle |
| Where to place the toolbar?
| | Constructors | | ToolbarIcons | | | ToolbarText | | | ToolbarBoth | | | ToolbarBothHoriz | |
| | Instances | |
|
|
| toolItemGetToolbarStyle :: ToolItemClass item => item -> IO ToolbarStyle |
| Returns the toolbar style used for the tool item.
|
|
| data ReliefStyle |
| I don't have a clue.
| | Constructors | | ReliefNormal | | | ReliefHalf | | | ReliefNone | |
| | Instances | |
|
|
| toolItemGetReliefStyle :: ToolItemClass item => item -> IO ReliefStyle |
| Returns the relief style of the tool item. See buttonSetReliefStyle.
|
|
| toolItemRetrieveProxyMenuItem :: ToolItemClass item => item -> IO (Maybe Widget) |
| Returns the MenuItem that was last set by toolItemSetProxyMenuItem,
ie. the MenuItem that is going to appear in the overflow menu.
|
|
| toolItemGetProxyMenuItem :: ToolItemClass item => item -> String -> IO (Maybe Widget) |
| If the menu item identifier string matches the string passed to
toolItemSetProxyMenuItem the returns the corresponding MenuItem.
|
|
| toolItemSetProxyMenuItem |
| :: (ToolItemClass item, MenuItemClass menuItem) | | | => item | | | -> String | Menu item identifier string | | -> menuItem | A MenuItem to be used in the
overflow menu | | -> IO () | | | Sets the MenuItem used in the toolbar overflow menu. The menu item identifier
is used to identify the caller of this function and should also be used with
toolItemGetProxyMenuItem.
|
|
|
| Produced by Haddock version 0.6 |
