fluid.size_lock

import fluid;

sizeLock!vframe(
    .sizeLimitX(400),       // Maximum width of 800 px
    .layout!(1, "center"),  // Use excess space to center the node
    label(
        "By using sizeLock and setting the right limit, a node can be "
        ~ "forced to use a specific amount of space. This can make your "
        ~ "app easier to use on a wide screen, without affecting smaller "
        ~ "windows or displays."
    ),
);

• @safe SizeLimit sizeLimit(size_t x, size_t y);
  @safe SizeLimit sizeLimitX(size_t x);
  @safe SizeLimit sizeLimitY(size_t y);
  @safe FloatSizeLimit sizeLimit(float x, float y);
  @safe FloatSizeLimit sizeLimitX(float x);
  @safe FloatSizeLimit sizeLimitY(float y);
  

  The sizeLimit node property sets the maximum amount of space a SizeLock node can use. sizeLimit can only be used with SizeLock.

  Parameters

  size_t x	Maximum width of the node in pixels.
  size_t y	Maximum height of the node in pixels.

  Return value

  A configured node parameter struct, which can be passed into the sizeLock node builder. This will be a SizeBounds struct if the input parameters are float (preferred), or SizeLimit if they are size_t like uint or ulong.

• struct FloatSizeLimit;
  

  This node property defines the maximum size for a SizeLock node. Nodes can be given a limit by setting either width or height.

  The init value defaults to no restrictions.

  • Vector2 limit;
    

    The imposed limit as a vector. The x field is the maximum width, and y is the maximum height. They both default to infinity, effectively not setting any limit.

  • ref @safe inout(float) width() inout return;
    

    Return value

    The maximum width imposed on the node.

  • @safe bool isWidthLimited() const;
    

    Return value

    True if there is a limit applied to node width.

  • ref @safe inout(float) height() inout return;
    

    Return value

    The maximum height imposed on the node.

  • @safe bool isHeightLimited() const;
    

    Return value

    True, if there is a limit applied to node height.

• template sizeLock(alias T)

  A node builder that constructs a SizeLock node. sizeLock can be used with other node builders, for example sizeLock!vframe() will use a vertical frame as its base, while sizeLock!hframe() will use a horizontal frame.

• class SizeLock(T : Node): T;
  

  SizeLock "locks" the size of a node, limiting the amount of space it will use from the space it is given.

  Size locks are extremely useful for responsible applications, as they can make sure the content doesn't span too much space on large screens. For example, a width limit can be set with sizeLimitX, preventing nodes from spanning the entire width of the screen.

  import fluid;
  
  // The frame will appear horizontally-centered in the parent node,
  // and will fill it vertically
  sizeLock!vframe(
      .layout!(1, "center", "fill"),
      .sizeLimitX(400),
      label("Hello, World!")
  );
  

  • SizeLimit limit;
    

    The maximum size of this node. If a value on either axis is 0, limit will not be applied on the axis.

    limit has been superseded by sizeLimit, which uses floats instead of integers, like the rest of Fluid. For now, it takes priority over sizeLimit if set.

  • FloatSizeLimit sizeLimit;
    

    The maximum size of the node.