Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ConstraintGuideMeta

[319:14] static extends: object

Generated metadata helpers for ConstraintGuide class surfaces.

Methods

  • properties ()

    Returns property metadata for ConstraintGuide.

    • @r A list.

class: ConstraintGuide

[18:7] extends: object

An invisible layout element in a GtkConstraintLayout. The GtkConstraintLayout treats guides like widgets. They can be used as the source or target of a GtkConstraint. 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 GtkWidget, a GtkConstraintGuide will not be drawn.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • ConstraintGuide ()

    Creates a new GtkConstraintGuide object.

  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asObject ()

    Wraps this handle as Object.

    • @r A Object object.
  • asConstraintTarget ()

    Wraps this handle as ConstraintTarget.

    • @r A ConstraintTarget object.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setMaxheight (int Value)

    The maximum height of the guide.

    • @p Value is the new property value.
    • @r None.
  • setMaxwidth (int Value)

    The maximum width of the guide.

    • @p Value is the new property value.
    • @r None.
  • setMinheight (int Value)

    The minimum height of the guide.

    • @p Value is the new property value.
    • @r None.
  • setMinwidth (int Value)

    The minimum width of the guide.

    • @p Value is the new property value.
    • @r None.
  • setName (string Value)

    A name that identifies the GtkConstraintGuide, for debugging.

    • @p Value is the new property value.
    • @r None.
  • setNatheight (int Value)

    The preferred, or natural, height of the guide.

    • @p Value is the new property value.
    • @r None.
  • setNatwidth (int Value)

    The preferred, or natural, width of the guide.

    • @p Value is the new property value.
    • @r None.
  • setStrength (string Value)

    The GtkConstraintStrength to be used for the constraint on the natural size of the guide.

    • @p Value is the new property value.
    • @r None.
  • get_name ()

    Retrieves the name set using gtk_constraint_guide_set_name().

  • get_strength ()

    Retrieves the strength set using gtk_constraint_guide_set_strength().

  • set_max_size (int width, int height)

    Sets the maximum size of @guide. If @guide is attached to a GtkConstraintLayout, the constraints will be updated to reflect the new size.

    • @p width is the new maximum width, or -1 to not change it.
    • @p height is the new maximum height, or -1 to not change it.
    • @r None.
  • set_min_size (int width, int height)

    Sets the minimum size of @guide. If @guide is attached to a GtkConstraintLayout, the constraints will be updated to reflect the new size.

    • @p width is the new minimum width, or -1 to not change it.
    • @p height is the new minimum height, or -1 to not change it.
    • @r None.
  • set_name (string name)

    Sets a name for the given GtkConstraintGuide. The name is useful for debugging purposes.

    • @p name is a name for the @guide.
    • @r None.
  • set_nat_size (int width, int height)

    Sets the natural size of @guide. If @guide is attached to a GtkConstraintLayout, the constraints will be updated to reflect the new size.

    • @p width is the new natural width, or -1 to not change it.
    • @p height is the new natural height, or -1 to not change it.
    • @r None.
  • set_strength (string strength)

    Sets the strength of the constraint on the natural size of the given GtkConstraintGuide.

    • @p strength is the strength of the constraint.
    • @r None.