wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/list_event.rb

@@ -0,0 +1,208 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A list event holds information about events associated with {Wx::ListCtrl} objects.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ListEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_list_begin_drag}(id, meth = nil, &block): Begin dragging with the left mouse button. 
+  # 
+  # - {Wx::EvtHandler#evt_list_begin_rdrag}(id, meth = nil, &block): Begin dragging with the right mouse button. 
+  # 
+  # - {Wx::EvtHandler#evt_list_begin_label_edit}(id, meth = nil, &block): Begin editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
+  # 
+  # - {Wx::EvtHandler#evt_list_end_label_edit}(id, meth = nil, &block): Finish editing a label. This can be prevented by calling {Wx::ListEvent#veto}. 
+  # 
+  # - {Wx::EvtHandler#evt_list_delete_item}(id, meth = nil, &block): Delete an item. 
+  # 
+  # - {Wx::EvtHandler#evt_list_delete_all_items}(id, meth = nil, &block): Delete all items. 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_selected}(id, meth = nil, &block): The item has been selected. Notice that the mouse is captured by the control itself when this event is generated, see event handling overview. 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_deselected}(id, meth = nil, &block): The item has been deselected. {Wx::ListEvent#get_index} may be -1 with virtual lists. 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_activated}(id, meth = nil, &block): The item has been activated (ENTER or double click). 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_focused}(id, meth = nil, &block): The currently focused item has changed. 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_middle_click}(id, meth = nil, &block): The middle mouse button has been clicked on an item. 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_right_click}(id, meth = nil, &block): The right mouse button has been clicked on an item. 
+  # 
+  # - {Wx::EvtHandler#evt_list_key_down}(id, meth = nil, &block): A key has been pressed. {Wx::ListEvent#get_index} may be -1 if no item is selected. 
+  # 
+  # - {Wx::EvtHandler#evt_list_insert_item}(id, meth = nil, &block): An item has been inserted. 
+  # 
+  # - {Wx::EvtHandler#evt_list_col_click}(id, meth = nil, &block): A column (m_col) has been left-clicked. 
+  # 
+  # - {Wx::EvtHandler#evt_list_col_right_click}(id, meth = nil, &block): A column (m_col) (which can be -1 if the click occurred outside any column) has been right-clicked. 
+  # 
+  # - {Wx::EvtHandler#evt_list_col_begin_drag}(id, meth = nil, &block): The user started resizing a column - can be vetoed. 
+  # 
+  # - {Wx::EvtHandler#evt_list_col_dragging}(id, meth = nil, &block): The divider between columns is being dragged. 
+  # 
+  # - {Wx::EvtHandler#evt_list_col_end_drag}(id, meth = nil, &block): A column has been resized by the user. 
+  # 
+  # - {Wx::EvtHandler#evt_list_cache_hint}(id, meth = nil, &block): Prepare cache for a virtual list control 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_checked}(id, meth = nil, &block): The item has been checked (new since wxWidgets 3.1.0). 
+  # 
+  # - {Wx::EvtHandler#evt_list_item_unchecked}(id, meth = nil, &block): The item has been unchecked (new since wxWidgets 3.1.0). 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::ListCtrl 
+  # 
+  # 
+  # @wxrb_require USE_LISTCTRL
+  class ListEvent < NotifyEvent
+  
+    # Constructor.
+    # @param commandType [Wx::TipWindow::EventType] 
+    # @param id [Integer] 
+    # @return [Wx::ListEvent]
+    def initialize(commandType=Wx::EVT_NULL, id=0) end
+    
+    # For EVT_LIST_CACHE_HINT event only: return the first item which the list control advises us to cache.
+    # @return [Integer]
+    def get_cache_from; end
+    alias_method :cache_from, :get_cache_from
+    
+    # For EVT_LIST_CACHE_HINT event only: return the last item (inclusive) which the list control advises us to cache.
+    # @return [Integer]
+    def get_cache_to; end
+    alias_method :cache_to, :get_cache_to
+    
+    # The column position: it is only used with COL events.
+    # 
+    # For the column dragging events, it is the column to the left of the divider being dragged, for the column click events it may be -1 if the user clicked in the list control header outside any column.
+    # @return [Integer]
+    def get_column; end
+    alias_method :column, :get_column
+    
+    # The data.
+    # @return [Integer]
+    def get_data; end
+    alias_method :data, :get_data
+    
+    # The image.
+    # @return [Integer]
+    def get_image; end
+    alias_method :image, :get_image
+    
+    # The item index.
+    # @return [Integer]
+    def get_index; end
+    alias_method :index, :get_index
+    
+    # An item object, used by some events.
+    # 
+    # See also {Wx::ListCtrl#set_item}.
+    # @return [Wx::ListItem]
+    def get_item; end
+    alias_method :item, :get_item
+    
+    # Key code if the event is a keypress event.
+    # @return [Integer]
+    def get_key_code; end
+    alias_method :key_code, :get_key_code
+    
+    # The (new) item label for EVT_LIST_END_LABEL_EDIT event.
+    # @return [Wx::String]
+    def get_label; end
+    alias_method :label, :get_label
+    
+    # The mask.
+    # @return [Integer]
+    def get_mask; end
+    alias_method :mask, :get_mask
+    
+    # The position of the mouse pointer if the event is a drag event.
+    # @return [Wx::Point]
+    def get_point; end
+    alias_method :point, :get_point
+    
+    # The text.
+    # @return [Wx::String]
+    def get_text; end
+    alias_method :text, :get_text
+    
+    # This method only makes sense for EVT_LIST_END_LABEL_EDIT message and returns true if it the label editing has been cancelled by the user ({Wx::ListEvent#get_label} returns an empty string in this case but it doesn't allow the application to distinguish between really cancelling the edit and the admittedly rare case when the user wants to rename it to an empty string).
+    # @return [Boolean]
+    def is_edit_cancelled; end
+    alias_method :edit_cancelled?, :is_edit_cancelled
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_key_code 
+    # @param code [Integer] 
+    # @return [void]
+    def set_key_code(code) end
+    alias_method :key_code=, :set_key_code
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_index 
+    # @param index [Integer] 
+    # @return [void]
+    def set_index(index) end
+    alias_method :index=, :set_index
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_column 
+    # @param col [Integer] 
+    # @return [void]
+    def set_column(col) end
+    alias_method :column=, :set_column
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_point 
+    # @param point [Array(Integer, Integer), Wx::Point] 
+    # @return [void]
+    def set_point(point) end
+    alias_method :point=, :set_point
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_item 
+    # @param item [Wx::ListItem] 
+    # @return [void]
+    def set_item(item) end
+    alias_method :item=, :set_item
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_cache_from 
+    # @param cacheFrom [Integer] 
+    # @return [void]
+    def set_cache_from(cacheFrom) end
+    alias_method :cache_from=, :set_cache_from
+    
+    # 
+    # 
+    # 
+    # @see Wx::ListEvent#get_cache_to 
+    # @param cacheTo [Integer] 
+    # @return [void]
+    def set_cache_to(cacheTo) end
+    alias_method :cache_to=, :set_cache_to
+    
+  end # ListEvent
+  
+
+end

data/lib/wx/doc/gen/listbook.rb

@@ -0,0 +1,116 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  LB_DEFAULT = 0
+  
+  # 
+  LB_TOP = 16
+  
+  # 
+  LB_BOTTOM = 32
+  
+  # 
+  LB_LEFT = 64
+  
+  # 
+  LB_RIGHT = 128
+  
+  # 
+  LB_ALIGN_MASK = 240
+  
+  # 
+  # 
+  EVT_LISTBOOK_PAGE_CHANGED = 10237
+  
+  # 
+  # 
+  EVT_LISTBOOK_PAGE_CHANGING = 10236
+  
+  # {Wx::Listbook} is a class similar to {Wx::Notebook} but which uses a {Wx::ListCtrl} to show the labels instead of the tabs.
+  # 
+  # The underlying {Wx::ListCtrl} displays page labels in a one-column report view by default. Calling Wx::BookCtrl::SetImageList will implicitly switch the control to use an icon view.
+  # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the page_samples_notebook to see {Wx::Listbook} in action.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::LB_DEFAULT}: Choose the default location for the labels depending on the current platform (left everywhere except Mac where it is top). 
+  # 
+  # - {Wx::LB_TOP}: Place labels above the page area. 
+  # 
+  # - {Wx::LB_LEFT}: Place labels on the left side. 
+  # 
+  # - {Wx::LB_RIGHT}: Place labels on the right side. 
+  # 
+  # - {Wx::LB_BOTTOM}: Place labels below the page area. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_listbook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGED} event. 
+  # 
+  # - {Wx::EvtHandler#evt_listbook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_LISTBOOK_PAGE_CHANGING} event. This event can be vetoed. 
+  # 
+  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # @see Wx::BookCtrl
+  # @see  Wx::Notebook
+  # @see  page_samples_notebook 
+  # 
+  # 
+  # @wxrb_require USE_LISTBOOK
+  class Listbook < BookCtrlBase
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::Listbook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
+    #   Constructs a listbook control.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::Listbook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''), &block)
+    #   Constructs a listbook control.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::Listbook] win new instance
+    #   @return [Wx::Listbook]
+    def initialize(*args) end
+    
+    # Create the list book control that has already been constructed with the default constructor.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
+    
+    # Returns the {Wx::ListView} associated with the control.
+    # @return [Wx::ListView]
+    def get_list_view; end
+    alias_method :list_view, :get_list_view
+    
+  end # Listbook
+  
+
+end