class Gtk::ConstraintGuide

Overview

A Gtk::ConstraintGuide is an invisible layout element in a Gtk::ConstraintLayout.

The Gtk::ConstraintLayout treats guides like widgets. They can be used as the source or target of a Gtk::Constraint.

Guides have a minimum, maximum and natural size. Depending on the constraints that are applied, they can act like a guideline that widgets can be aligned to, or like flexible space.

Unlike a Gtk::Widget, a Gtk::ConstraintGuide will not be drawn.

Included Modules

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/constraint_guide.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gtk::ConstraintTarget

to_unsafe to_unsafe

Constructor methods inherited from module Gtk::ConstraintTarget

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::ConstraintTarget

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new : self #

Creates a new Gtk::ConstraintGuide object.


[View source]
def self.new(*, max_height : Int32 | Nil = nil, max_width : Int32 | Nil = nil, min_height : Int32 | Nil = nil, min_width : Int32 | Nil = nil, name : String | Nil = nil, nat_height : Int32 | Nil = nil, nat_width : Int32 | Nil = nil, strength : Gtk::ConstraintStrength | Nil = nil) #

[View source]

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def max_height : Int32 #

[View source]
def max_height=(value : Int32) : Int32 #

[View source]
def max_size : Nil #

Gets the maximum size of guide.


[View source]
def max_width : Int32 #

[View source]
def max_width=(value : Int32) : Int32 #

[View source]
def min_height : Int32 #

[View source]
def min_height=(value : Int32) : Int32 #

[View source]
def min_size : Nil #

Gets the minimum size of guide.


[View source]
def min_width : Int32 #

[View source]
def min_width=(value : Int32) : Int32 #

[View source]
def name : String | Nil #

Retrieves the name set using gtk_constraint_guide_set_name().


[View source]
def name=(value : String) : String #

[View source]
def name=(value : Nil) : Nil #

Set #name property to nil.


[View source]
def name=(name : String | Nil) : Nil #

Sets a name for the given Gtk::ConstraintGuide.

The name is useful for debugging purposes.


[View source]
def name? : String | Nil #

Same as #name, but can return nil.


[View source]
def nat_height : Int32 #

[View source]
def nat_height=(value : Int32) : Int32 #

[View source]
def nat_size : Nil #

Gets the natural size of guide.


[View source]
def nat_width : Int32 #

[View source]
def nat_width=(value : Int32) : Int32 #

[View source]
def set_max_size(width : Int32, height : Int32) : Nil #

Sets the maximum size of guide.

If guide is attached to a Gtk::ConstraintLayout, the constraints will be updated to reflect the new size.


[View source]
def set_min_size(width : Int32, height : Int32) : Nil #

Sets the minimum size of guide.

If guide is attached to a Gtk::ConstraintLayout, the constraints will be updated to reflect the new size.


[View source]
def set_nat_size(width : Int32, height : Int32) : Nil #

Sets the natural size of guide.

If guide is attached to a Gtk::ConstraintLayout, the constraints will be updated to reflect the new size.


[View source]
def strength : Gtk::ConstraintStrength #

Retrieves the strength set using gtk_constraint_guide_set_strength().


[View source]
def strength=(strength : Gtk::ConstraintStrength) : Nil #

Sets the strength of the constraint on the natural size of the given Gtk::ConstraintGuide.


[View source]