Class: Wx::GBSizerItem

Inherits:
SizerItem show all
Defined in:
lib/wx/doc/gen/gb_sizer_item.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

The GBSizerItem class is used by the GridBagSizer for tracking the items in the sizer.

It adds grid position and spanning information to the normal SizerItem by adding GBPosition and GBSpan attributes. Most of the time you will not need to use a GBSizerItem directly in your code, but there are a couple of cases where it is handy.

Category: Window Layout

Instance Method Summary collapse

Methods inherited from SizerItem

#assign_sizer, #assign_spacer, #assign_window, #calc_min, #delete_windows, #detach_sizer, #get_border, #get_flag, #get_id, #get_min_size, #get_position, #get_proportion, #get_ratio, #get_rect, #get_size, #get_sizer, #get_spacer, #get_user_data, #get_window, #is_shown, #is_sizer, #is_spacer, #is_window, #set_border, #set_dimension, #set_flag, #set_id, #set_init_size, #set_min_size, #set_proportion, #set_ratio, #set_user_data, #show

Methods inherited from Object

#clone, #dup, #initialize, #is_same_as, #un_share

Constructor Details

This class inherits a constructor from Wx::Object

Instance Method Details

#get_end_pos ⇒ Array(Integer,Integer) Also known as: end_pos

Get the row and column of the endpoint of this item.

Returns:

  • (Array(Integer,Integer)) 


31
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 31

def get_end_pos; end

#get_gb_sizer ⇒ Wx::GridBagSizer Also known as: gb_sizer

Returns:



62
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 62

def get_gb_sizer; end

#get_pos ⇒ Wx::GBPosition Also known as: pos

Get the grid position of the item.

Returns:



21
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 21

def get_pos; end

#get_span ⇒ Wx::GBSpan Also known as: span

Get the row and column spanning of the item.

Returns:



26
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 26

def get_span; end

#intersects(other) ⇒ Boolean #intersects(pos, span) ⇒ Boolean

Overloads:

  • #intersects(other) ⇒ Boolean

    Returns true if this item and the other item intersect.

    Parameters:

    Returns:

    • (Boolean)
  • #intersects(pos, span) ⇒ Boolean

    Returns true if the given pos/span would intersect with this item.

    Parameters:

    Returns:

    • (Boolean) 


43
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 43

def intersects(*args) end

#set_pos(pos) ⇒ Boolean Also known as: pos=

If the item is already a member of a sizer then first ensure that there is no other item that would intersect with this one at the new position, then set the new position.

Returns true if the change is successful and after the next Layout the item will be moved.

Parameters:

Returns:

  • (Boolean) 


50
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 50

def set_pos(pos) end

#set_span(span) ⇒ Boolean Also known as: span=

If the item is already a member of a sizer then first ensure that there is no other item that would intersect with this one with its new spanning size, then set the new spanning.

Returns true if the change is successful and after the next Layout the item will be resized.

Parameters:

Returns:

  • (Boolean) 


58
 
# File 'lib/wx/doc/gen/gb_sizer_item.rb', line 58

def set_span(span) end