GI.Gdk.Structs.Geometry

The Geometry struct gives the window manager information about a window’s geometry constraints. Normally you would set these on the GTK+ level using gtk_window_set_geometry_hints(). GtkWindow then sets the hints on the Window it creates.

windowSetGeometryHints expects the hints to be fully valid already and simply passes them to the window manager; in contrast, gtk_window_set_geometry_hints() performs some interpretation. For example, GtkWindow will apply the hints to the geometry widget instead of the toplevel window, if you set a geometry widget. Also, the minWidth/minHeight/maxWidth/maxHeight fields may be set to -1, and GtkWindow will substitute the size request of the window or geometry widget. If the minimum size hint is not provided, GtkWindow will use its requisition as the minimum size. If the minimum size is provided and a geometry widget is set, GtkWindow will take the minimum size as the minimum size of the geometry widget rather than the entire window. The base size is treated similarly.

The canonical use-case for gtk_window_set_geometry_hints() is to get a terminal widget to resize properly. Here, the terminal text area should be the geometry widget; GtkWindow will then automatically set the base size to the size of other widgets in the terminal window, such as the menubar and scrollbar. Then, the widthInc and heightInc fields should be set to the size of one character in the terminal. Finally, the base size should be set to the size of one character. The net effect is that the minimum size of the terminal will have a 1x1 character terminal area, and only terminal sizes on the “character grid” will be allowed.

Here’s an example of how the terminal example would be implemented, assuming a terminal area widget called “terminal” and a toplevel window “toplevel”:

C code

	GdkGeometry hints;

	hints.base_width = terminal->char_width;
        hints.base_height = terminal->char_height;
        hints.min_width = terminal->char_width;
        hints.min_height = terminal->char_height;
        hints.width_inc = terminal->char_width;
        hints.height_inc = terminal->char_height;

 gtk_window_set_geometry_hints (GTK_WINDOW (toplevel),
                                GTK_WIDGET (terminal),
                                &hints,
                                GDK_HINT_RESIZE_INC |
                                GDK_HINT_MIN_SIZE |
                                GDK_HINT_BASE_SIZE);

The other useful fields are the minAspect and maxAspect fields; these contain a width/height ratio as a floating point number. If a geometry widget is set, the aspect applies to the geometry widget rather than the entire window. The most common use of these hints is probably to set minAspect and maxAspect to the same value, thus forcing the window to keep a constant aspect ratio.

Exported types

newtype Geometry

Constructors

Geometry (ManagedPtr Geometry)

Instances

WrappedPtr Geometry

Methods

wrappedPtrCalloc :: IO (Ptr Geometry)

wrappedPtrCopy :: Geometry -> IO Geometry

wrappedPtrFree :: Maybe (FunPtr (Ptr Geometry -> IO ()))

(~) AttrOpTag tag AttrSet => Constructible Geometry tag

Methods

new :: MonadIO m => (ManagedPtr Geometry -> Geometry) -> [AttrOp Geometry tag] -> m Geometry

((~) * info (ResolveGeometryMethod t Geometry), MethodInfo * info Geometry p) => IsLabel t (Geometry -> p)

Methods

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

((~) * info (ResolveGeometryMethod t Geometry), MethodInfo * info Geometry p) => IsLabelProxy t (Geometry -> p)

Methods

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

HasAttributeList * Geometry

type AttributeList Geometry

type AttributeList Geometry

newZeroGeometry :: MonadIO m => m Geometry

Construct a Geometry struct initialized to zero.

noGeometry :: Maybe Geometry

Properties

baseHeight

geometry_baseHeight :: AttrLabelProxy "baseHeight"

getGeometryBaseHeight :: MonadIO m => Geometry -> m Int32

setGeometryBaseHeight :: MonadIO m => Geometry -> Int32 -> m ()

baseWidth

geometry_baseWidth :: AttrLabelProxy "baseWidth"

getGeometryBaseWidth :: MonadIO m => Geometry -> m Int32

setGeometryBaseWidth :: MonadIO m => Geometry -> Int32 -> m ()

heightInc

geometry_heightInc :: AttrLabelProxy "heightInc"

getGeometryHeightInc :: MonadIO m => Geometry -> m Int32

setGeometryHeightInc :: MonadIO m => Geometry -> Int32 -> m ()

maxAspect

geometry_maxAspect :: AttrLabelProxy "maxAspect"

getGeometryMaxAspect :: MonadIO m => Geometry -> m Double

setGeometryMaxAspect :: MonadIO m => Geometry -> Double -> m ()

maxHeight

geometry_maxHeight :: AttrLabelProxy "maxHeight"

getGeometryMaxHeight :: MonadIO m => Geometry -> m Int32

setGeometryMaxHeight :: MonadIO m => Geometry -> Int32 -> m ()

maxWidth

geometry_maxWidth :: AttrLabelProxy "maxWidth"

getGeometryMaxWidth :: MonadIO m => Geometry -> m Int32

setGeometryMaxWidth :: MonadIO m => Geometry -> Int32 -> m ()

minAspect

geometry_minAspect :: AttrLabelProxy "minAspect"

getGeometryMinAspect :: MonadIO m => Geometry -> m Double

setGeometryMinAspect :: MonadIO m => Geometry -> Double -> m ()

minHeight

geometry_minHeight :: AttrLabelProxy "minHeight"

getGeometryMinHeight :: MonadIO m => Geometry -> m Int32

setGeometryMinHeight :: MonadIO m => Geometry -> Int32 -> m ()

minWidth

geometry_minWidth :: AttrLabelProxy "minWidth"

getGeometryMinWidth :: MonadIO m => Geometry -> m Int32

setGeometryMinWidth :: MonadIO m => Geometry -> Int32 -> m ()

widthInc

geometry_widthInc :: AttrLabelProxy "widthInc"

getGeometryWidthInc :: MonadIO m => Geometry -> m Int32

setGeometryWidthInc :: MonadIO m => Geometry -> Int32 -> m ()

winGravity

geometry_winGravity :: AttrLabelProxy "winGravity"

getGeometryWinGravity :: MonadIO m => Geometry -> m Gravity

setGeometryWinGravity :: MonadIO m => Geometry -> Gravity -> m ()