class Iup::GridBox

A container which arranges its widgets in a left-to-right, top-to-bottom order to form a grid-like arrangement.

Example

The following example sets up a 2x2 grid of labels, each centered with a small gap between the columns:

box = Iup::GridBox.new(lbl1, lbl2, lbl3, lbl4) do |b|
  b.sizelin = 1 # the second line is used for calculating spacing
  b.numdiv = 2 # arranges labels with 2 columns
  b.alignmentlin = 'acenter'
  b.gapcol = 5
end

Also see: HBox, VBox

Attributes

cgapcol [RW]

n, horizontal space in characters between columns.

cgaplin [RW]

n, vertical space in characters between lines.

clientoffset [R]

returns current offset of box in its client as “widthxheight”.

clientsize [R]

returns current size of box as “widthxheight”.

cmargin [RW]

Margin in x and y directions in characters, value as “mxn”.

expand [RW]

Allows container to fill available space in indicated direction. Values ‘no’ / ‘horizontal’ / ‘vertical’ / ‘yes’.

expandchildren [RW]

Set to allow children to expand fully, values as ‘yes’ / ‘no’ / ‘horizontal’ / ‘vertical’.

fittochildren [RW]

‘column’ / ‘line’, n -> force column/line n to fit largest element in that column/line.

gapcol [RW]

Horizontal space in pixels between columns.

gaplin [RW]

Vertical space in pixels between lines.

homogeneouscol [RW]

Forces all columns to have same horizontal space. Values as ‘yes’ / ‘no’.

homogeneouslin [RW]

Forces all lines to have same vertical space. Values as ‘yes’ / ‘no’.

margin [RW]

Margin in x and y directions in pixels, value as “mxn”.

normalsize [RW]

Set to make natural size of children same, values as ‘yes’ / ‘no’ / ‘horizontal’ / ‘vertical’.

numcol [R]

returns number of columns.

numdiv [RW]

‘auto’ / n, controls number of divisions in direction as determined by orientation.

numlin [R]

returns number of lines.

orientation [RW]

Controls distribution of children, in lines or columns. Value as ‘horizontal’ / ‘vertical’.

position [R]

returns position in pixels within client window as “x,y”.

rastersize [RW]

Size of the container, in pixels, value as “widthxheight”.

sizecol [RW]

Index of column to use for calculating height of lines. Note: make sure column is within range, else can crash.

sizelin [RW]

Index of line to use for calculating width of columns. Note: make sure line is within range, else can crash.

Public Class Methods

new (*widgets) { |self| ... }

Source

# File lib/wrapped/gridbox.rb, line 28
def initialize *widgets
  @handle = IupLib.IupGridBox(*widget_list(widgets))

  # run any provided block on instance, to set up further attributes
  yield self if block_given?
end

Creates an instance of the gridbox. If a block is given, the new instance is yielded to it.

widgets -one or more child widgets

Public Instance Methods

alignmentcol() # Reads value of "ALIGNMENTCOL"

alignmentcol(val) # Sets "ALIGNMENTCOL" to val

alignmentcol(n, val) # Sets alignment of column n to val

Source

# File lib/wrapped/gridbox.rb, line 43
def alignmentcol val=nil, val2=nil 
  if val.nil?
    IupLib.IupGetAttribute(@handle, 'ALIGNMENTCOL').first
  elsif val2.nil?
    IupLib.IupSetAttribute @handle, 'ALIGNMENTCOL', val.to_s
  else
    IupLib.IupSetAttribute @handle, "ALIGNMENTCOL#{val}", val2.to_s
  end
end

Alignment values are ‘ALEFT’ / ‘ACENTER’ / ‘ARIGHT’.

alignmentlin() # Reads value of "ALIGNMENTLIN"

alignmentlin(val) # Sets "ALIGNMENTLIN" to val

alignmentlin(n, val) # Sets alignment of line n to val

Source

# File lib/wrapped/gridbox.rb, line 59
def alignmentlin val=nil, val2=nil 
  if val.nil?
    IupLib.IupGetAttribute(@handle, 'ALIGNMENTLIN').first
  elsif val2.nil?
    IupLib.IupSetAttribute @handle, 'ALIGNMENTLIN', val.to_s
  else
    IupLib.IupSetAttribute @handle, "ALIGNMENTLIN#{val}", val2.to_s
  end
end

Alignment values are ‘ATOP’ / ‘ACENTER’ / ‘ABOTTOM’.