gtk-0.12.5.6: Binding to the Gtk+ graphical user interface library.

Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Safe HaskellNone

Graphics.UI.Gtk.MenuComboToolbar.ToolItem

Contents

Description

The base class of widgets that can be added to Toolbar

  • Module available since Gtk+ version 2.4

Synopsis

Detail

ToolItems are widgets that can appear on a toolbar. 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.

For toolbar items that contain buttons, see the ToolButton, ToggleToolButton and RadioToolButton classes.

Class Hierarchy

 | GObject
 | +----Object
 | +----Widget
 | +----Container
 | +----Bin
 | +----ToolItem
 | +----ToolButton
 | +----SeparatorToolItem

Types

Constructors

Methods

toolItemSetHomogeneousSource

Arguments

:: ToolItemClass self 
=> self 
-> Bool

homogeneous - whether toolItem is the same size as other homogeneous items

-> 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 self => self -> IO BoolSource

Returns whether the tool item is the same size as other homogeneous items. See toolItemSetHomogeneous.

toolItemSetExpand :: ToolItemClass self => self -> Bool -> IO ()Source

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 self => self -> IO BoolSource

Returns whether the tool item is allocated extra space. See toolItemSetExpand.

toolItemSetTooltipSource

Arguments

:: ToolItemClass self 
=> self 
-> Tooltips

tooltips - The Tooltips object to be used

-> String

tipText - text to be used as tooltip text for toolItem

-> String

tipPrivate - text to be used as private tooltip text

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

Removed in Gtk3.

toolItemSetUseDragWindow :: ToolItemClass self => self -> Bool -> IO ()Source

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 self => self -> IO BoolSource

Returns whether the tool item has a drag window. See toolItemSetUseDragWindow.

toolItemSetVisibleHorizontal :: ToolItemClass self => self -> Bool -> IO ()Source

Sets whether the tool item is visible when the toolbar is docked horizontally.

toolItemGetVisibleHorizontal :: ToolItemClass self => self -> IO BoolSource

Returns whether the tool item is visible on toolbars that are docked horizontally.

toolItemSetVisibleVertical :: ToolItemClass self => self -> Bool -> IO ()Source

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 self => self -> IO BoolSource

Returns whether the tool item is visible when the toolbar is docked vertically. See toolItemSetVisibleVertical.

toolItemSetIsImportant :: ToolItemClass self => self -> Bool -> IO ()Source

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 self => self -> IO BoolSource

Returns whether the tool item is considered important. See toolItemSetIsImportant

data IconSize Source

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

toolItemGetIconSize :: ToolItemClass self => self -> IO IconSizeSource

Returns the icon size used for the tool item.

toolItemGetOrientation :: ToolItemClass self => self -> IO OrientationSource

Returns the orientation used for the tool item.

toolItemGetToolbarStyle :: ToolItemClass self => self -> IO ToolbarStyleSource

Returns the toolbar style used for the tool item.

Possibilities are: [ToolbarBoth] meaning the tool item should show both an icon and a label, stacked vertically [ToolbarIcons] meaning the toolbar shows only icons [ToolbarText] meaning the tool item should only show text [ToolbarBothHoriz] meaning the tool item should show both an icon and a label, arranged horizontally

data ReliefStyle Source

I don't have a clue.

toolItemGetReliefStyle :: ToolItemClass self => self -> IO ReliefStyleSource

Returns the relief style of the tool item. See buttonSetReliefStyle.

toolItemRetrieveProxyMenuItem :: ToolItemClass self => self -> IO (Maybe Widget)Source

Returns the MenuItem that was last set by toolItemSetProxyMenuItem, ie. the MenuItem that is going to appear in the overflow menu.

toolItemGetProxyMenuItemSource

Arguments

:: ToolItemClass self 
=> self 
-> String

menuItemId - a string used to identify the menu item

-> IO (Maybe Widget)

returns The MenuItem passed to toolItemSetProxyMenuItem, if the menuItemIds match.

If menuItemId matches the string passed to toolItemSetProxyMenuItem return the corresponding MenuItem.

toolItemSetProxyMenuItemSource

Arguments

:: (ToolItemClass self, MenuItemClass menuItem) 
=> self 
-> String

menuItemId - a string used to identify menuItem

-> menuItem

menuItem - a MenuItem to be used in the overflow menu

-> IO () 

Sets the MenuItem used in the toolbar overflow menu. The menuItemId is used to identify the caller of this function and should also be used with toolItemGetProxyMenuItem.

toolItemGetEllipsizeModeSource

Arguments

:: ToolItemClass item 
=> item 
-> IO EllipsizeMode

returns a PangoEllipsizeMode indicating how text in toolItem should be ellipsized.

Returns the ellipsize mode used for toolItem. Custom subclasses of ToolItem should call this function to find out how text should be ellipsized.

  • Available since Gtk+ version 2.20

toolItemGetTextAlignmentSource

Arguments

:: ToolItemClass item 
=> item 
-> IO Double

returns a gfloat indicating the horizontal text alignment used for toolItem

Returns the text alignment used for toolItem. Custom subclasses of ToolItem should call this function to find out how text should be aligned.

toolItemGetTextOrientationSource

Arguments

:: ToolItemClass item 
=> item 
-> IO Orientation

returns a Orientation indicating the orientation used for toolItem

Returns the text orientation used for toolItem. Custom subclasses of ToolItem should call this function to find out how text should be orientated.

toolItemGetTextSizeGroup :: ToolItemClass item => item -> IO SizeGroupSource

Returns the size group used for labels in toolItem. Custom subclasses of ToolItem should call this function and use the size group for labels.

Attributes

toolItemVisibleHorizontal :: ToolItemClass self => Attr self BoolSource

Whether the toolbar item is visible when the toolbar is in a horizontal orientation.

Default value: True

toolItemVisibleVertical :: ToolItemClass self => Attr self BoolSource

Whether the toolbar item is visible when the toolbar is in a vertical orientation.

Default value: True

toolItemIsImportant :: ToolItemClass self => Attr self BoolSource

Whether the toolbar item is considered important. When True, toolbar buttons show text in ToolbarBothHoriz mode.

Default value: False