| Maintainer | gtk2hs-users@lists.sourceforge.net |
|---|---|
| Stability | provisional |
| Portability | portable (depends on GHC) |
| Safe Haskell | None |
| Language | Haskell98 |
Graphics.UI.Gtk.Ornaments.Frame
Description
A bin with a decorative frame and optional label
- data Frame
- class BinClass o => FrameClass o
- castToFrame :: GObjectClass obj => obj -> Frame
- gTypeFrame :: GType
- toFrame :: FrameClass o => o -> Frame
- frameNew :: IO Frame
- frameSetLabel :: (FrameClass self, GlibString string) => self -> string -> IO ()
- frameGetLabel :: (FrameClass self, GlibString string) => self -> IO string
- frameSetLabelWidget :: (FrameClass self, WidgetClass labelWidget) => self -> labelWidget -> IO ()
- frameGetLabelWidget :: FrameClass self => self -> IO (Maybe Widget)
- frameSetLabelAlign :: FrameClass self => self -> Float -> Float -> IO ()
- frameGetLabelAlign :: FrameClass self => self -> IO (Float, Float)
- data ShadowType
- frameSetShadowType :: FrameClass self => self -> ShadowType -> IO ()
- frameGetShadowType :: FrameClass self => self -> IO ShadowType
- frameLabel :: (FrameClass self, GlibString string) => Attr self string
- frameLabelXAlign :: FrameClass self => Attr self Float
- frameLabelYAlign :: FrameClass self => Attr self Float
- frameShadowType :: FrameClass self => Attr self ShadowType
- frameLabelWidget :: (FrameClass self, WidgetClass labelWidget) => ReadWriteAttr self (Maybe Widget) labelWidget
Detail
The frame widget is a Bin that surrounds its child with a decorative
frame and an optional label. If present, the label is drawn in a gap in the
top side of the frame. The position of the label can be controlled with
frameSetLabelAlign.
Class Hierarchy
Types
class BinClass o => FrameClass o Source
Instances
castToFrame :: GObjectClass obj => obj -> Frame Source
toFrame :: FrameClass o => o -> Frame Source
Constructors
Creates a new Frame without a label.
- A label can later be set by calling
frameSetLabel.
Methods
Arguments
| :: (FrameClass self, GlibString string) | |
| => self | |
| -> string |
|
| -> IO () |
Sets the text of the label.
Arguments
| :: (FrameClass self, GlibString string) | |
| => self | |
| -> IO string | returns the text in the label, or if there was no label
widget or the lable widget was not a |
If the frame's label widget is a Label, returns the text in the label
widget.
frameSetLabelWidget :: (FrameClass self, WidgetClass labelWidget) => self -> labelWidget -> IO () Source
Sets the label widget for the frame. This is the widget that will appear embedded in the top edge of the frame as a title.
Arguments
| :: FrameClass self | |
| => self | |
| -> IO (Maybe Widget) | returns the label widget, or |
Retrieves the label widget for the frame. See frameSetLabelWidget.
Arguments
| :: FrameClass self | |
| => self | |
| -> Float |
|
| -> Float |
|
| -> IO () |
Sets the alignment of the frame widget's label. The default values for a newly created frame are 0.0 and 0.5.
Arguments
| :: FrameClass self | |
| => self | |
| -> IO (Float, Float) | (xalign, yalign) |
Retrieves the X and Y alignment of the frame's label. See
frameSetLabelAlign.
data ShadowType Source
Shadow types
Constructors
| ShadowNone | |
| ShadowIn | |
| ShadowOut | |
| ShadowEtchedIn | |
| ShadowEtchedOut |
Instances
frameSetShadowType :: FrameClass self => self -> ShadowType -> IO () Source
Sets the shadow type of the frame.
frameGetShadowType :: FrameClass self => self -> IO ShadowType Source
Retrieves the shadow type of the frame. See frameSetShadowType.
Attributes
frameLabel :: (FrameClass self, GlibString string) => Attr self string Source
Text of the frame's label.
frameLabelXAlign :: FrameClass self => Attr self Float Source
The horizontal alignment of the label.
Allowed values: [0,1]
Default value: 0.5
frameLabelYAlign :: FrameClass self => Attr self Float Source
The vertical alignment of the label.
Allowed values: [0,1]
Default value: 0.5
frameShadowType :: FrameClass self => Attr self ShadowType Source
Appearance of the frame border.
Default value: ShadowEtchedIn
frameLabelWidget :: (FrameClass self, WidgetClass labelWidget) => ReadWriteAttr self (Maybe Widget) labelWidget Source
A widget to display in place of the usual frame label.