| Portability | portable (depends on GHC) |
|---|---|
| Stability | provisional |
| Maintainer | gtk2hs-users@lists.sourceforge.net |
| Safe Haskell | Safe-Infered |
Graphics.UI.Gtk.Abstract.ButtonBox
Description
Base class for HButtonBox and VButtonBox
- data ButtonBox
- class BoxClass o => ButtonBoxClass o
- castToButtonBox :: GObjectClass obj => obj -> ButtonBox
- gTypeButtonBox :: GType
- toButtonBox :: ButtonBoxClass o => o -> ButtonBox
- data ButtonBoxStyle
- buttonBoxGetLayout :: ButtonBoxClass self => self -> IO ButtonBoxStyle
- buttonBoxSetLayout :: ButtonBoxClass self => self -> ButtonBoxStyle -> IO ()
- buttonBoxSetChildSecondary :: (ButtonBoxClass self, WidgetClass child) => self -> child -> Bool -> IO ()
- buttonBoxGetChildSecondary :: (ButtonBoxClass self, WidgetClass child) => self -> child -> IO Bool
- buttonBoxLayoutStyle :: ButtonBoxClass self => Attr self ButtonBoxStyle
- buttonBoxChildSecondary :: (ButtonBoxClass self, WidgetClass child) => child -> Attr self Bool
Detail
The primary purpose of this class is to keep track of the various
properties of HButtonBox and VButtonBox widgets.
buttonBoxGetChildSize retrieves the minimum width and height for
widgets in a given button box. buttonBoxSetChildSize allows those
properties to be changed.
The internal padding of buttons can be retrieved and changed per button
box using buttonBoxGetChildIpadding and buttonBoxSetChildIpadding
respectively.
buttonBoxGetSpacing and buttonBoxSetSpacing retrieve and change
default number of pixels between buttons, respectively.
buttonBoxGetLayout and buttonBoxSetLayout retrieve and alter the
method used to spread the buttons in a button box across the container,
respectively.
The main purpose of ButtonBox is to make sure the children have all the
same size. Therefore it ignores the homogeneous property which it inherited
from Box, and always behaves as if homogeneous was True.
Class Hierarchy
|GObject| +----Object| +----Widget| +----Container| +----Box| +----ButtonBox | +----HButtonBox| +----VButtonBox
Types
class BoxClass o => ButtonBoxClass o Source
castToButtonBox :: GObjectClass obj => obj -> ButtonBoxSource
toButtonBox :: ButtonBoxClass o => o -> ButtonBoxSource
data ButtonBoxStyle Source
Dictate the style that a ButtonBox uses to align it contents
Constructors
| ButtonboxDefaultStyle | |
| ButtonboxSpread | |
| ButtonboxEdge | |
| ButtonboxStart | |
| ButtonboxEnd | |
| ButtonboxCenter |
Instances
Methods
buttonBoxGetLayout :: ButtonBoxClass self => self -> IO ButtonBoxStyleSource
Retrieves the method being used to arrange the buttons in the button box.
Arguments
| :: ButtonBoxClass self | |
| => self | |
| -> ButtonBoxStyle |
|
| -> IO () |
Changes the way buttons are arranged in their container.
buttonBoxSetChildSecondarySource
Arguments
| :: (ButtonBoxClass self, WidgetClass child) | |
| => self | |
| -> child |
|
| -> Bool |
|
| -> IO () |
Sets whether child should appear in a secondary group of children. A
typical use of a secondary child is the help button in a dialog.
This group appears after the other children if the style is
ButtonboxStart, ButtonboxSpread or ButtonboxEdge, and before the other
children if the style is ButtonboxEnd. For horizontal button boxes, the
definition of before/after depends on direction of the widget (see
widgetSetDirection). If the style is ButtonboxStart or ButtonboxEnd,
then the secondary children are aligned at the other end of the button box
from the main children. For the other styles, they appear immediately next
to the main children.
buttonBoxGetChildSecondarySource
Arguments
| :: (ButtonBoxClass self, WidgetClass child) | |
| => self | |
| -> child |
|
| -> IO Bool | returns whether |
Returns whether child should appear in a secondary group of children.
- Available since Gtk+ version 2.4
Attributes
buttonBoxLayoutStyle :: ButtonBoxClass self => Attr self ButtonBoxStyleSource
How to layout the buttons in the box. Possible values are default, spread, edge, start and end.
Default value: ButtonboxDefaultStyle
Child Attributes
buttonBoxChildSecondary :: (ButtonBoxClass self, WidgetClass child) => child -> Attr self BoolSource
If True, the child appears in a secondary group of children, suitable
for, e.g., help buttons.
Default value: False