Geometry
open class Geometry : GeometryProtocol
The Geometry type acts as an owner of an underlying GdkGeometry instance.
It provides the methods that can operate on this data type through GeometryProtocol conformance.
Use Geometry as a strong reference or owner of a GdkGeometry instance.
The GdkGeometry 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 GdkWindow it creates.
gdk_window_set_geometry_hints() 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
min_width/min_height/max_width/max_height 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 width_inc and height_inc 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 Language Example):
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 min_aspect and max_aspect 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 min_aspect and
max_aspect to the same value, thus forcing the window to keep a constant
aspect ratio.
-
Untyped pointer to the underlying `GdkGeometry` instance.For type-safe access, use the generated, typed pointer
_ptrproperty instead.Declaration
Swift
public let ptr: UnsafeMutableRawPointer! -
Designated initialiser from the underlying
Cdata type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init(_ op: UnsafeMutablePointer<GdkGeometry>)Parameters
oppointer to the underlying object
-
Designated initialiser from a constant pointer to the underlying
Cdata type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init(_ op: UnsafePointer<GdkGeometry>)Parameters
oppointer to the underlying object
-
Optional initialiser from a non-mutating
gpointerto the underlyingCdata type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init!(gpointer op: gpointer?)Parameters
opgpointer to the underlying object
-
Optional initialiser from a non-mutating
gconstpointerto the underlyingCdata type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init!(gconstpointer op: gconstpointer?)Parameters
oppointer to the underlying object
-
Optional initialiser from a constant pointer to the underlying
Cdata type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init!(_ op: UnsafePointer<GdkGeometry>?)Parameters
oppointer to the underlying object
-
Optional initialiser from the underlying
Cdata type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init!(_ op: UnsafeMutablePointer<GdkGeometry>?)Parameters
oppointer to the underlying object
-
Designated initialiser from the underlying
Cdata type.GdkGeometrydoes not allow reference counting, so despite the name no actual retaining will occur. i.e., ownership is transferred to theGeometryinstance.Declaration
Swift
@inlinable public init(retaining op: UnsafeMutablePointer<GdkGeometry>)Parameters
oppointer to the underlying object
-
Reference intialiser for a related type that implements
GeometryProtocolGdkGeometrydoes not allow reference counting.Declaration
Swift
@inlinable public init<T>(_ other: T) where T : GeometryProtocolParameters
otheran instance of a related type that implements
GeometryProtocol -
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init<T>(cPointer p: UnsafeMutablePointer<T>)Parameters
cPointerpointer to the underlying object
-
Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)Parameters
cPointerpointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init(raw p: UnsafeRawPointer)Parameters
praw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init(retainingRaw raw: UnsafeRawPointer) -
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public required init(raw p: UnsafeMutableRawPointer)Parameters
pmutable raw pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init(retainingRaw raw: UnsafeMutableRawPointer)Parameters
rawmutable raw pointer to the underlying object
-
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init(opaquePointer p: OpaquePointer)Parameters
popaque pointer to the underlying object
-
Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to
GeometryProtocol.Declaration
Swift
@inlinable public init(retainingOpaquePointer p: OpaquePointer)Parameters
popaque pointer to the underlying object
View on GitHub
Install in Dash
Geometry Class Reference