# :stopdoc: # This file is automatically generated by the WXRuby3 documentation # generator. Do not alter this file. # :startdoc: module Wx # # DEFAULT_SPAN = nil # A {Wx::Sizer} that can lay out items in a virtual grid like a {Wx::FlexGridSizer} but in this case explicit positioning of the items is allowed using {Wx::GBPosition}, and items can optionally span more than one row and/or column using {Wx::GBSpan}. # === # # Category: Window Layout # class GridBagSizer < FlexGridSizer # @overload add(window, pos, span=Wx::DEFAULT_SPAN, flag=0, border=0, userData=nil) # Adds the given item to the given position. # A valid pointer if the item was successfully placed at the given position, or NULL if something was already there. # @param window [Wx::Window] # @param pos [Wx::GBPosition] # @param span [Wx::GBSpan] # @param flag [Integer] # @param border [Integer] # @param userData [Wx::Object] # @return [Wx::SizerItem] # @overload add(sizer, pos, span=Wx::DEFAULT_SPAN, flag=0, border=0, userData=nil) # Adds the given item to the given position. # A valid pointer if the item was successfully placed at the given position, or NULL if something was already there. # @param sizer [Wx::Sizer] # @param pos [Wx::GBPosition] # @param span [Wx::GBSpan] # @param flag [Integer] # @param border [Integer] # @param userData [Wx::Object] # @return [Wx::SizerItem] # @overload add(width, height, pos, span=Wx::DEFAULT_SPAN, flag=0, border=0, userData=nil) # Adds a spacer to the given position. # width and height specify the dimension of the spacer to be added. # A valid pointer if the spacer was successfully placed at the given position, or NULL if something was already there. # @param width [Integer] # @param height [Integer] # @param pos [Wx::GBPosition] # @param span [Wx::GBSpan] # @param flag [Integer] # @param border [Integer] # @param userData [Wx::Object] # @return [Wx::SizerItem] def add(*args) end # @overload check_for_intersection(item, excludeItem=nil) # Look at all items and see if any intersect (or would overlap) the given item. # Returns true if so, false if there would be no overlap. If an excludeItem is given then it will not be checked for intersection, for example it may be the item we are checking the position of. # @param item [Wx::GBSizerItem] # @param excludeItem [Wx::GBSizerItem] # @return [Boolean] # @overload check_for_intersection(pos, span, excludeItem=nil) # Look at all items and see if any intersect (or would overlap) the given item. # Returns true if so, false if there would be no overlap. If an excludeItem is given then it will not be checked for intersection, for example it may be the item we are checking the position of. # @param pos [Wx::GBPosition] # @param span [Wx::GBSpan] # @param excludeItem [Wx::GBSizerItem] # @return [Boolean] def check_for_intersection(*args) end # @overload find_item(window) # Find the sizer item for the given window or subsizer, returns NULL if not found. # (non-recursive) # @param window [Wx::Window] # @return [Wx::GBSizerItem] # @overload find_item(sizer) # Find the sizer item for the given window or subsizer, returns NULL if not found. # (non-recursive) # @param sizer [Wx::Sizer] # @return [Wx::GBSizerItem] def find_item(*args) end # @overload get_item_position(window) # Get the grid position of the specified item. # @param window [Wx::Window] # @return [Wx::GBPosition] # @overload get_item_position(sizer) # Get the grid position of the specified item. # @param sizer [Wx::Sizer] # @return [Wx::GBPosition] # @overload get_item_position(index) # Get the grid position of the specified item. # @param index [Integer] # @return [Wx::GBPosition] def get_item_position(*args) end alias_method :item_position, :get_item_position # @overload get_item_span(window) # Get the row/col spanning of the specified item. # @param window [Wx::Window] # @return [Wx::GBSpan] # @overload get_item_span(sizer) # Get the row/col spanning of the specified item. # @param sizer [Wx::Sizer] # @return [Wx::GBSpan] # @overload get_item_span(index) # Get the row/col spanning of the specified item. # @param index [Integer] # @return [Wx::GBSpan] def get_item_span(*args) end alias_method :item_span, :get_item_span # @overload set_item_position(window, pos) # Set the grid position of the specified item. # Returns true on success. If the move is not allowed (because an item is already there) then false is returned. # @param window [Wx::Window] # @param pos [Wx::GBPosition] # @return [Boolean] # @overload set_item_position(sizer, pos) # Set the grid position of the specified item. # Returns true on success. If the move is not allowed (because an item is already there) then false is returned. # @param sizer [Wx::Sizer] # @param pos [Wx::GBPosition] # @return [Boolean] # @overload set_item_position(index, pos) # Set the grid position of the specified item. # Returns true on success. If the move is not allowed (because an item is already there) then false is returned. # @param index [Integer] # @param pos [Wx::GBPosition] # @return [Boolean] def set_item_position(*args) end # @overload set_item_span(window, span) # Set the row/col spanning of the specified item. # Returns true on success. If the move is not allowed (because an item is already there) then false is returned. # @param window [Wx::Window] # @param span [Wx::GBSpan] # @return [Boolean] # @overload set_item_span(sizer, span) # Set the row/col spanning of the specified item. # Returns true on success. If the move is not allowed (because an item is already there) then false is returned. # @param sizer [Wx::Sizer] # @param span [Wx::GBSpan] # @return [Boolean] # @overload set_item_span(index, span) # Set the row/col spanning of the specified item. # Returns true on success. If the move is not allowed (because an item is already there) then false is returned. # @param index [Integer] # @param span [Wx::GBSpan] # @return [Boolean] def set_item_span(*args) end # Constructor, with optional parameters to specify the gap between the rows and columns. # @param vgap [Integer] # @param hgap [Integer] # @return [Wx::GridBagSizer] def initialize(vgap=0, hgap=0) end # Called when the managed size of the sizer is needed or when layout needs done. # @return [Wx::Size] def calc_min; end # Return the sizer item located at the point given in pt, or NULL if there is no item at that point. # The (x,y) coordinates in pt correspond to the client coordinates of the window using the sizer for layout. (non-recursive) # @param pt [Array(Integer, Integer), Wx::Point] # @return [Wx::GBSizerItem] def find_item_at_point(pt) end # Return the sizer item for the given grid cell, or NULL if there is no item at that position. # (non-recursive) # @param pos [Wx::GBPosition] # @return [Wx::GBSizerItem] def find_item_at_position(pos) end # Return the sizer item that has a matching user data (it only compares pointer values) or NULL if not found. # (non-recursive) # @param userData [Wx::Object] # @return [Wx::GBSizerItem] def find_item_with_data(userData) end # Get the size of the specified cell, including hgap and vgap. # Only valid after window layout has been performed. # @param row [Integer] # @param col [Integer] # @return [Wx::Size] def get_cell_size(row, col) end alias_method :cell_size, :get_cell_size # Get the size used for cells in the grid with no item. # @return [Wx::Size] def get_empty_cell_size; end alias_method :empty_cell_size, :get_empty_cell_size # Called when the managed size of the sizer is needed or when layout needs done. # @param minSize [Array(Integer, Integer), Wx::Size] # @return [void] def reposition_children(minSize) end # Set the size used for cells in the grid with no item. # @param sz [Array(Integer, Integer), Wx::Size] # @return [void] def set_empty_cell_size(sz) end alias_method :empty_cell_size=, :set_empty_cell_size end # GridBagSizer # This class is used to hold the row and column spanning attributes of items in a {Wx::GridBagSizer}. # === # # Category: Window Layout # # # @note This class is untracked and should not be derived from nor instances extended! class GBSpan < ::Object # @overload initialize() # Default constructor, setting the rowspan and colspan to (1,1) meaning that the item occupies one cell in each direction. # @return [Wx::GBSpan] # @overload initialize(rowspan, colspan) # Construct a new {Wx::GBSpan}, setting the rowspan and colspan. # @param rowspan [Integer] # @param colspan [Integer] # @return [Wx::GBSpan] def initialize(*args) end # Get the current colspan value. # @return [Integer] def get_colspan; end alias_method :colspan, :get_colspan # Get the current rowspan value. # @return [Integer] def get_rowspan; end alias_method :rowspan, :get_rowspan # Set a new colspan value. # @param colspan [Integer] # @return [void] def set_colspan(colspan) end alias_method :colspan=, :set_colspan # Set a new rowspan value. # @param rowspan [Integer] # @return [void] def set_rowspan(rowspan) end alias_method :rowspan=, :set_rowspan # Compare equality of two {Wx::GBSpans}. # @param o [Wx::GBSpan] # @return [Boolean] def ==(o) end end # GBSpan # This class represents the position of an item in a virtual grid of rows and columns managed by a {Wx::GridBagSizer}. # === # # Category: Window Layout # # # @note This class is untracked and should not be derived from nor instances extended! class GBPosition < ::Object # @overload initialize() # Default constructor, setting the row and column to (0,0). # @return [Wx::GBPosition] # @overload initialize(row, col) # Construct a new {Wx::GBPosition}, setting the row and column. # @param row [Integer] # @param col [Integer] # @return [Wx::GBPosition] def initialize(*args) end # Get the current column value. # @return [Integer] def get_col; end alias_method :col, :get_col # Get the current row value. # @return [Integer] def get_row; end alias_method :row, :get_row # Set a new column value. # @param col [Integer] # @return [void] def set_col(col) end alias_method :col=, :set_col # Set a new row value. # @param row [Integer] # @return [void] def set_row(row) end alias_method :row=, :set_row # Compare equality of two {Wx::GBPositions}. # @param p [Wx::GBPosition] # @return [Boolean] def ==(p) end end # GBPosition end