GI.Gtk.Objects.Frame

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.

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
├── border
├── <label widget>
╰── <child>

GtkFrame has a main CSS node with name frame and a subnode with name border. The border node is used to render the visible border. The style class .flat can appear with the main node.

Exported types

newtype Frame

Constructors

Frame (ManagedPtr Frame)

Instances

GObject Frame

Methods

gobjectType :: Frame -> IO GType

IsImplementorIface Frame

IsObject Frame

IsWidget Frame

IsFrame Frame

IsContainer Frame

IsBin Frame

IsBuildable Frame

((~) * info (ResolveFrameMethod t Frame), MethodInfo * info Frame p) => IsLabel t (Frame -> p)

Methods

fromLabel :: Proxy# Symbol t -> Frame -> p

((~) * info (ResolveFrameMethod t Frame), MethodInfo * info Frame p) => IsLabelProxy t (Frame -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Frame -> p

HasAttributeList * Frame

type AttributeList Frame

type AttributeList Frame

type SignalList Frame

type SignalList Frame

class GObject o => IsFrame o

Instances

(GObject a, UnknownAncestorError Constraint Frame a) => IsFrame a

IsFrame Frame

IsFrame AspectFrame

toFrame :: IsFrame o => o -> IO Frame

noFrame :: Maybe Frame

Methods

getLabel

data FrameGetLabelMethodInfo

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsFrame a) => MethodInfo * FrameGetLabelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameGetLabelMethodInfo a -> signature -> s

frameGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m (Maybe Text)

Returns: the text in the label, or Nothing if there was no label widget or the lable widget was not a Label. This string is owned by GTK+ and must not be modified or freed.

If the frame’s label widget is a Label, returns the text in the label widget. (The frame will have a Label for the label widget if a non-Nothing argument was passed to frameNew.)

getLabelAlign

data FrameGetLabelAlignMethodInfo

Instances

((~) * signature (m (Float, Float)), MonadIO m, IsFrame a) => MethodInfo * FrameGetLabelAlignMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameGetLabelAlignMethodInfo a -> signature -> s

frameGetLabelAlign

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m (Float, Float)

Retrieves the X and Y alignment of the frame’s label. See frameSetLabelAlign.

getLabelWidget

data FrameGetLabelWidgetMethodInfo

Instances

((~) * signature (m (Maybe Widget)), MonadIO m, IsFrame a) => MethodInfo * FrameGetLabelWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameGetLabelWidgetMethodInfo a -> signature -> s

frameGetLabelWidget

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m (Maybe Widget)

Returns: the label widget, or Nothing if there is none.

Retrieves the label widget for the frame. See frameSetLabelWidget.

getShadowType

data FrameGetShadowTypeMethodInfo

Instances

((~) * signature (m ShadowType), MonadIO m, IsFrame a) => MethodInfo * FrameGetShadowTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameGetShadowTypeMethodInfo a -> signature -> s

frameGetShadowType

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> m ShadowType

Returns: the current shadow type of the frame.

Retrieves the shadow type of the frame. See frameSetShadowType.

new

frameNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

label: the text to use as the label of the frame

-> m Frame

Returns: a new Frame widget

Creates a new Frame, with optional label label. If label is Nothing, the label is omitted.

setLabel

data FrameSetLabelMethodInfo

Instances

((~) * signature (Maybe Text -> m ()), MonadIO m, IsFrame a) => MethodInfo * FrameSetLabelMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameSetLabelMethodInfo a -> signature -> s

frameSetLabel

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> Maybe Text

label: the text to use as the label of the frame

-> m ()

Sets the text of the label. If label is Nothing, the current label is removed.

setLabelAlign

data FrameSetLabelAlignMethodInfo

Instances

((~) * signature (Float -> Float -> m ()), MonadIO m, IsFrame a) => MethodInfo * FrameSetLabelAlignMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameSetLabelAlignMethodInfo a -> signature -> s

frameSetLabelAlign

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> Float

xalign: The position of the label along the top edge of the widget. A value of 0.0 represents left alignment; 1.0 represents right alignment.

-> Float

yalign: The y alignment of the label. A value of 0.0 aligns under the frame; 1.0 aligns above the frame. If the values are exactly 0.0 or 1.0 the gap in the frame won’t be painted because the label will be completely above or below the frame.

-> m ()

Sets the alignment of the frame widget’s label. The default values for a newly created frame are 0.0 and 0.5.

setLabelWidget

data FrameSetLabelWidgetMethodInfo

Instances

((~) * signature (Maybe b -> m ()), MonadIO m, IsFrame a, IsWidget b) => MethodInfo * FrameSetLabelWidgetMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameSetLabelWidgetMethodInfo a -> signature -> s

frameSetLabelWidget

Arguments

:: (HasCallStack, MonadIO m, IsFrame a, IsWidget b)

=> a

frame: a Frame

-> Maybe b

labelWidget: the new label widget

-> m ()

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.

setShadowType

data FrameSetShadowTypeMethodInfo

Instances

((~) * signature (ShadowType -> m ()), MonadIO m, IsFrame a) => MethodInfo * FrameSetShadowTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy FrameSetShadowTypeMethodInfo a -> signature -> s

frameSetShadowType

Arguments

:: (HasCallStack, MonadIO m, IsFrame a)

=> a

frame: a Frame

-> ShadowType

type: the new ShadowType

-> m ()

Sets the shadow type for frame.

Properties

label

data FrameLabelPropertyInfo

Instances

AttrInfo FrameLabelPropertyInfo

Associated Types

type AttrAllowedOps FrameLabelPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FrameLabelPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FrameLabelPropertyInfo :: * -> Constraint

type AttrGetType FrameLabelPropertyInfo :: *

type AttrLabel FrameLabelPropertyInfo :: Symbol

type AttrOrigin FrameLabelPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FrameLabelPropertyInfo o => Proxy * FrameLabelPropertyInfo -> o -> IO (AttrGetType FrameLabelPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FrameLabelPropertyInfo o, AttrSetTypeConstraint FrameLabelPropertyInfo b) => Proxy * FrameLabelPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FrameLabelPropertyInfo o => Proxy * FrameLabelPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FrameLabelPropertyInfo o, AttrSetTypeConstraint FrameLabelPropertyInfo b) => Proxy * FrameLabelPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FrameLabelPropertyInfo

type AttrOrigin FrameLabelPropertyInfo = Frame

type AttrLabel FrameLabelPropertyInfo

type AttrLabel FrameLabelPropertyInfo = "label"

type AttrGetType FrameLabelPropertyInfo

type AttrGetType FrameLabelPropertyInfo = Maybe Text

type AttrBaseTypeConstraint FrameLabelPropertyInfo

type AttrBaseTypeConstraint FrameLabelPropertyInfo = IsFrame

type AttrSetTypeConstraint FrameLabelPropertyInfo

type AttrSetTypeConstraint FrameLabelPropertyInfo = * ~ Text

type AttrAllowedOps FrameLabelPropertyInfo

type AttrAllowedOps FrameLabelPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

clearFrameLabel :: (MonadIO m, IsFrame o) => o -> m ()

constructFrameLabel :: IsFrame o => Text -> IO (GValueConstruct o)

frameLabel :: AttrLabelProxy "label"

getFrameLabel :: (MonadIO m, IsFrame o) => o -> m (Maybe Text)

setFrameLabel :: (MonadIO m, IsFrame o) => o -> Text -> m ()

labelWidget

data FrameLabelWidgetPropertyInfo

Instances

AttrInfo FrameLabelWidgetPropertyInfo

Associated Types

type AttrAllowedOps FrameLabelWidgetPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FrameLabelWidgetPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo :: * -> Constraint

type AttrGetType FrameLabelWidgetPropertyInfo :: *

type AttrLabel FrameLabelWidgetPropertyInfo :: Symbol

type AttrOrigin FrameLabelWidgetPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo o => Proxy * FrameLabelWidgetPropertyInfo -> o -> IO (AttrGetType FrameLabelWidgetPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo o, AttrSetTypeConstraint FrameLabelWidgetPropertyInfo b) => Proxy * FrameLabelWidgetPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo o => Proxy * FrameLabelWidgetPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo o, AttrSetTypeConstraint FrameLabelWidgetPropertyInfo b) => Proxy * FrameLabelWidgetPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FrameLabelWidgetPropertyInfo

type AttrOrigin FrameLabelWidgetPropertyInfo = Frame

type AttrLabel FrameLabelWidgetPropertyInfo

type AttrLabel FrameLabelWidgetPropertyInfo = "label-widget"

type AttrGetType FrameLabelWidgetPropertyInfo

type AttrGetType FrameLabelWidgetPropertyInfo = Maybe Widget

type AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo

type AttrBaseTypeConstraint FrameLabelWidgetPropertyInfo = IsFrame

type AttrSetTypeConstraint FrameLabelWidgetPropertyInfo

type AttrSetTypeConstraint FrameLabelWidgetPropertyInfo = IsWidget

type AttrAllowedOps FrameLabelWidgetPropertyInfo

type AttrAllowedOps FrameLabelWidgetPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag))))

clearFrameLabelWidget :: (MonadIO m, IsFrame o) => o -> m ()

constructFrameLabelWidget :: (IsFrame o, IsWidget a) => a -> IO (GValueConstruct o)

frameLabelWidget :: AttrLabelProxy "labelWidget"

getFrameLabelWidget :: (MonadIO m, IsFrame o) => o -> m (Maybe Widget)

setFrameLabelWidget :: (MonadIO m, IsFrame o, IsWidget a) => o -> a -> m ()

labelXalign

data FrameLabelXalignPropertyInfo

Instances

AttrInfo FrameLabelXalignPropertyInfo

Associated Types

type AttrAllowedOps FrameLabelXalignPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FrameLabelXalignPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FrameLabelXalignPropertyInfo :: * -> Constraint

type AttrGetType FrameLabelXalignPropertyInfo :: *

type AttrLabel FrameLabelXalignPropertyInfo :: Symbol

type AttrOrigin FrameLabelXalignPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FrameLabelXalignPropertyInfo o => Proxy * FrameLabelXalignPropertyInfo -> o -> IO (AttrGetType FrameLabelXalignPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FrameLabelXalignPropertyInfo o, AttrSetTypeConstraint FrameLabelXalignPropertyInfo b) => Proxy * FrameLabelXalignPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FrameLabelXalignPropertyInfo o => Proxy * FrameLabelXalignPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FrameLabelXalignPropertyInfo o, AttrSetTypeConstraint FrameLabelXalignPropertyInfo b) => Proxy * FrameLabelXalignPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FrameLabelXalignPropertyInfo

type AttrOrigin FrameLabelXalignPropertyInfo = Frame

type AttrLabel FrameLabelXalignPropertyInfo

type AttrLabel FrameLabelXalignPropertyInfo = "label-xalign"

type AttrGetType FrameLabelXalignPropertyInfo

type AttrGetType FrameLabelXalignPropertyInfo = Float

type AttrBaseTypeConstraint FrameLabelXalignPropertyInfo

type AttrBaseTypeConstraint FrameLabelXalignPropertyInfo = IsFrame

type AttrSetTypeConstraint FrameLabelXalignPropertyInfo

type AttrSetTypeConstraint FrameLabelXalignPropertyInfo = * ~ Float

type AttrAllowedOps FrameLabelXalignPropertyInfo

type AttrAllowedOps FrameLabelXalignPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFrameLabelXalign :: IsFrame o => Float -> IO (GValueConstruct o)

frameLabelXalign :: AttrLabelProxy "labelXalign"

getFrameLabelXalign :: (MonadIO m, IsFrame o) => o -> m Float

setFrameLabelXalign :: (MonadIO m, IsFrame o) => o -> Float -> m ()

labelYalign

data FrameLabelYalignPropertyInfo

Instances

AttrInfo FrameLabelYalignPropertyInfo

Associated Types

type AttrAllowedOps FrameLabelYalignPropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FrameLabelYalignPropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FrameLabelYalignPropertyInfo :: * -> Constraint

type AttrGetType FrameLabelYalignPropertyInfo :: *

type AttrLabel FrameLabelYalignPropertyInfo :: Symbol

type AttrOrigin FrameLabelYalignPropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FrameLabelYalignPropertyInfo o => Proxy * FrameLabelYalignPropertyInfo -> o -> IO (AttrGetType FrameLabelYalignPropertyInfo)

attrSet :: (AttrBaseTypeConstraint FrameLabelYalignPropertyInfo o, AttrSetTypeConstraint FrameLabelYalignPropertyInfo b) => Proxy * FrameLabelYalignPropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FrameLabelYalignPropertyInfo o => Proxy * FrameLabelYalignPropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FrameLabelYalignPropertyInfo o, AttrSetTypeConstraint FrameLabelYalignPropertyInfo b) => Proxy * FrameLabelYalignPropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FrameLabelYalignPropertyInfo

type AttrOrigin FrameLabelYalignPropertyInfo = Frame

type AttrLabel FrameLabelYalignPropertyInfo

type AttrLabel FrameLabelYalignPropertyInfo = "label-yalign"

type AttrGetType FrameLabelYalignPropertyInfo

type AttrGetType FrameLabelYalignPropertyInfo = Float

type AttrBaseTypeConstraint FrameLabelYalignPropertyInfo

type AttrBaseTypeConstraint FrameLabelYalignPropertyInfo = IsFrame

type AttrSetTypeConstraint FrameLabelYalignPropertyInfo

type AttrSetTypeConstraint FrameLabelYalignPropertyInfo = * ~ Float

type AttrAllowedOps FrameLabelYalignPropertyInfo

type AttrAllowedOps FrameLabelYalignPropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFrameLabelYalign :: IsFrame o => Float -> IO (GValueConstruct o)

frameLabelYalign :: AttrLabelProxy "labelYalign"

getFrameLabelYalign :: (MonadIO m, IsFrame o) => o -> m Float

setFrameLabelYalign :: (MonadIO m, IsFrame o) => o -> Float -> m ()

shadowType

data FrameShadowTypePropertyInfo

Instances

AttrInfo FrameShadowTypePropertyInfo

Associated Types

type AttrAllowedOps FrameShadowTypePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint FrameShadowTypePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint FrameShadowTypePropertyInfo :: * -> Constraint

type AttrGetType FrameShadowTypePropertyInfo :: *

type AttrLabel FrameShadowTypePropertyInfo :: Symbol

type AttrOrigin FrameShadowTypePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint FrameShadowTypePropertyInfo o => Proxy * FrameShadowTypePropertyInfo -> o -> IO (AttrGetType FrameShadowTypePropertyInfo)

attrSet :: (AttrBaseTypeConstraint FrameShadowTypePropertyInfo o, AttrSetTypeConstraint FrameShadowTypePropertyInfo b) => Proxy * FrameShadowTypePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint FrameShadowTypePropertyInfo o => Proxy * FrameShadowTypePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint FrameShadowTypePropertyInfo o, AttrSetTypeConstraint FrameShadowTypePropertyInfo b) => Proxy * FrameShadowTypePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin FrameShadowTypePropertyInfo

type AttrOrigin FrameShadowTypePropertyInfo = Frame

type AttrLabel FrameShadowTypePropertyInfo

type AttrLabel FrameShadowTypePropertyInfo = "shadow-type"

type AttrGetType FrameShadowTypePropertyInfo

type AttrGetType FrameShadowTypePropertyInfo = ShadowType

type AttrBaseTypeConstraint FrameShadowTypePropertyInfo

type AttrBaseTypeConstraint FrameShadowTypePropertyInfo = IsFrame

type AttrSetTypeConstraint FrameShadowTypePropertyInfo

type AttrSetTypeConstraint FrameShadowTypePropertyInfo = * ~ ShadowType

type AttrAllowedOps FrameShadowTypePropertyInfo

type AttrAllowedOps FrameShadowTypePropertyInfo = (:) AttrOpTag AttrSet ((:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ([] AttrOpTag)))

constructFrameShadowType :: IsFrame o => ShadowType -> IO (GValueConstruct o)

frameShadowType :: AttrLabelProxy "shadowType"

getFrameShadowType :: (MonadIO m, IsFrame o) => o -> m ShadowType

setFrameShadowType :: (MonadIO m, IsFrame o) => o -> ShadowType -> m ()