Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
The frame widget is a widget that surrounds its child with a decorative
frame and an optional label. If present, the label is drawn inside
the top edge of the frame. The horizontal position of the label can
be controlled with frameSetLabelAlign
.
GtkFrame as GtkBuildable
The GtkFrame implementation of the GtkBuildable interface supports placing a child in the label position by specifying “label” as the “type” attribute of a <child> element. A normal content child can be specified without specifying a <child> type attribute.
An example of a UI definition fragment with GtkFrame: > >class="GtkFrame" > type="label" > class="GtkLabel" id="frame_label"/ > /child > child > class="GtkEntry" id="frame_content"/ > /child >/object
CSS nodes
plain code
frame ├── <label widget> ╰── <child>
GtkFrame has a main CSS node with name “frame”, which is used to draw the visible border. You can set the appearance of the border using CSS properties like “border-style” on this node.
Synopsis
- newtype Frame = Frame (ManagedPtr Frame)
- class (GObject o, IsDescendantOf Frame o) => IsFrame o
- toFrame :: (MonadIO m, IsFrame o) => o -> m Frame
- frameGetChild :: (HasCallStack, MonadIO m, IsFrame a) => a -> m (Maybe Widget)
- frameGetLabel :: (HasCallStack, MonadIO m, IsFrame a) => a -> m (Maybe Text)
- frameGetLabelAlign :: (HasCallStack, MonadIO m, IsFrame a) => a -> m Float
- frameGetLabelWidget :: (HasCallStack, MonadIO m, IsFrame a) => a -> m (Maybe Widget)
- frameNew :: (HasCallStack, MonadIO m) => Maybe Text -> m Frame
- frameSetChild :: (HasCallStack, MonadIO m, IsFrame a, IsWidget b) => a -> Maybe b -> m ()
- frameSetLabel :: (HasCallStack, MonadIO m, IsFrame a) => a -> Maybe Text -> m ()
- frameSetLabelAlign :: (HasCallStack, MonadIO m, IsFrame a) => a -> Float -> m ()
- frameSetLabelWidget :: (HasCallStack, MonadIO m, IsFrame a, IsWidget b) => a -> Maybe b -> m ()
- clearFrameChild :: (MonadIO m, IsFrame o) => o -> m ()
- constructFrameChild :: (IsFrame o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getFrameChild :: (MonadIO m, IsFrame o) => o -> m (Maybe Widget)
- setFrameChild :: (MonadIO m, IsFrame o, IsWidget a) => o -> a -> m ()
- clearFrameLabel :: (MonadIO m, IsFrame o) => o -> m ()
- constructFrameLabel :: (IsFrame o, MonadIO m) => Text -> m (GValueConstruct o)
- getFrameLabel :: (MonadIO m, IsFrame o) => o -> m (Maybe Text)
- setFrameLabel :: (MonadIO m, IsFrame o) => o -> Text -> m ()
- clearFrameLabelWidget :: (MonadIO m, IsFrame o) => o -> m ()
- constructFrameLabelWidget :: (IsFrame o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getFrameLabelWidget :: (MonadIO m, IsFrame o) => o -> m (Maybe Widget)
- setFrameLabelWidget :: (MonadIO m, IsFrame o, IsWidget a) => o -> a -> m ()
- constructFrameLabelXalign :: (IsFrame o, MonadIO m) => Float -> m (GValueConstruct o)
- getFrameLabelXalign :: (MonadIO m, IsFrame o) => o -> m Float
- setFrameLabelXalign :: (MonadIO m, IsFrame o) => o -> Float -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Frame Source # | |
IsGValue Frame Source # | Convert |
ManagedPtrNewtype Frame Source # | |
Defined in GI.Gtk.Objects.Frame toManagedPtr :: Frame -> ManagedPtr Frame # | |
TypedObject Frame Source # | |
Defined in GI.Gtk.Objects.Frame | |
GObject Frame Source # | |
Defined in GI.Gtk.Objects.Frame | |
HasParentTypes Frame Source # | |
Defined in GI.Gtk.Objects.Frame | |
type ParentTypes Frame Source # | |
Defined in GI.Gtk.Objects.Frame |
class (GObject o, IsDescendantOf Frame o) => IsFrame o Source #
Instances
(GObject o, IsDescendantOf Frame o) => IsFrame o Source # | |
Defined in GI.Gtk.Objects.Frame |
Methods
Overloaded methods
getChild
:: (HasCallStack, MonadIO m, IsFrame a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the child widget of |
Gets the child widget of frame
.
getLabel
getLabelAlign
:: (HasCallStack, MonadIO m, IsFrame a) | |
=> a |
|
-> m Float |
Retrieves the X alignment of the frame’s label. See
frameSetLabelAlign
.
getLabelWidget
:: (HasCallStack, MonadIO m, IsFrame a) | |
=> a |
|
-> m (Maybe Widget) | Returns: the label widget, or |
Retrieves the label widget for the frame. See
frameSetLabelWidget
.
new
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> m Frame | Returns: a new |
setChild
:: (HasCallStack, MonadIO m, IsFrame a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the child widget of frame
.
setLabel
:: (HasCallStack, MonadIO m, IsFrame a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
setLabelAlign
:: (HasCallStack, MonadIO m, IsFrame a) | |
=> a |
|
-> Float |
|
-> m () |
Sets the X alignment of the frame widget’s label. The default value for a newly created frame is 0.0.
setLabelWidget
:: (HasCallStack, MonadIO m, IsFrame a, IsWidget b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets the Frame
:label-widget
for the frame. This is the widget that
will appear embedded in the top edge of the frame as a title.
Properties
child
No description available in the introspection data.
clearFrameChild :: (MonadIO m, IsFrame o) => o -> m () Source #
Set the value of the “child
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#child
constructFrameChild :: (IsFrame o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “child
” property. This is rarely needed directly, but it is used by new
.
getFrameChild :: (MonadIO m, IsFrame o) => o -> m (Maybe Widget) Source #
Get the value of the “child
” property.
When overloading is enabled, this is equivalent to
get
frame #child
setFrameChild :: (MonadIO m, IsFrame o, IsWidget a) => o -> a -> m () Source #
Set the value of the “child
” property.
When overloading is enabled, this is equivalent to
set
frame [ #child:=
value ]
label
No description available in the introspection data.
clearFrameLabel :: (MonadIO m, IsFrame o) => o -> m () Source #
Set the value of the “label
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#label
constructFrameLabel :: (IsFrame o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “label
” property. This is rarely needed directly, but it is used by new
.
getFrameLabel :: (MonadIO m, IsFrame o) => o -> m (Maybe Text) Source #
Get the value of the “label
” property.
When overloading is enabled, this is equivalent to
get
frame #label
setFrameLabel :: (MonadIO m, IsFrame o) => o -> Text -> m () Source #
Set the value of the “label
” property.
When overloading is enabled, this is equivalent to
set
frame [ #label:=
value ]
labelWidget
No description available in the introspection data.
clearFrameLabelWidget :: (MonadIO m, IsFrame o) => o -> m () Source #
Set the value of the “label-widget
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#labelWidget
constructFrameLabelWidget :: (IsFrame o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “label-widget
” property. This is rarely needed directly, but it is used by new
.
getFrameLabelWidget :: (MonadIO m, IsFrame o) => o -> m (Maybe Widget) Source #
Get the value of the “label-widget
” property.
When overloading is enabled, this is equivalent to
get
frame #labelWidget
setFrameLabelWidget :: (MonadIO m, IsFrame o, IsWidget a) => o -> a -> m () Source #
Set the value of the “label-widget
” property.
When overloading is enabled, this is equivalent to
set
frame [ #labelWidget:=
value ]
labelXalign
No description available in the introspection data.
constructFrameLabelXalign :: (IsFrame o, MonadIO m) => Float -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “label-xalign
” property. This is rarely needed directly, but it is used by new
.
getFrameLabelXalign :: (MonadIO m, IsFrame o) => o -> m Float Source #
Get the value of the “label-xalign
” property.
When overloading is enabled, this is equivalent to
get
frame #labelXalign
setFrameLabelXalign :: (MonadIO m, IsFrame o) => o -> Float -> m () Source #
Set the value of the “label-xalign
” property.
When overloading is enabled, this is equivalent to
set
frame [ #labelXalign:=
value ]