wxruby3 1.6.1 → 1.7.0

data/lib/wx/doc/gen/aui/aui_notebook_event.rb

@@ -0,0 +1,233 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # 
+    # 
+    # 
+    # 
+    # @wxrb_require USE_AUI
+    class AuiNotebookOption < Wx::Enum
+    
+      # 
+      # 
+      AUI_NB_TOP = Wx::AUI::AuiNotebookOption.new(1)
+      
+      # 
+      # 
+      AUI_NB_LEFT = Wx::AUI::AuiNotebookOption.new(2)
+      
+      # 
+      # 
+      AUI_NB_RIGHT = Wx::AUI::AuiNotebookOption.new(4)
+      
+      # 
+      # 
+      AUI_NB_BOTTOM = Wx::AUI::AuiNotebookOption.new(8)
+      
+      # 
+      # 
+      AUI_NB_TAB_SPLIT = Wx::AUI::AuiNotebookOption.new(16)
+      
+      # 
+      # 
+      AUI_NB_TAB_MOVE = Wx::AUI::AuiNotebookOption.new(32)
+      
+      # 
+      # 
+      AUI_NB_TAB_EXTERNAL_MOVE = Wx::AUI::AuiNotebookOption.new(64)
+      
+      # 
+      # 
+      AUI_NB_TAB_FIXED_WIDTH = Wx::AUI::AuiNotebookOption.new(128)
+      
+      # 
+      # 
+      AUI_NB_SCROLL_BUTTONS = Wx::AUI::AuiNotebookOption.new(256)
+      
+      # 
+      # 
+      AUI_NB_WINDOWLIST_BUTTON = Wx::AUI::AuiNotebookOption.new(512)
+      
+      # 
+      # 
+      AUI_NB_CLOSE_BUTTON = Wx::AUI::AuiNotebookOption.new(1024)
+      
+      # 
+      # 
+      AUI_NB_CLOSE_ON_ACTIVE_TAB = Wx::AUI::AuiNotebookOption.new(2048)
+      
+      # 
+      # 
+      AUI_NB_CLOSE_ON_ALL_TABS = Wx::AUI::AuiNotebookOption.new(4096)
+      
+      # 
+      # 
+      AUI_NB_MIDDLE_CLICK_CLOSE = Wx::AUI::AuiNotebookOption.new(8192)
+      
+      # 
+      # 
+      AUI_NB_MULTILINE = Wx::AUI::AuiNotebookOption.new(16384)
+      
+      # Allow the user to pin tabs by using the pin button.
+      # 
+      AUI_NB_PIN_ON_ACTIVE_TAB = Wx::AUI::AuiNotebookOption.new(32768)
+      
+      # Allow the user to unpin pinned tabs by using the unpin button.
+      # 
+      AUI_NB_UNPIN_ON_ALL_PINNED = Wx::AUI::AuiNotebookOption.new(65536)
+      
+      # 
+      # 
+      AUI_NB_DEFAULT_STYLE = Wx::AUI::AuiNotebookOption.new(10545)
+      
+    end # AuiNotebookOption
+    
+    # Tab kind for {Wx::AUI::AuiNotebook} pages.
+    # 
+    # See {Wx::AUI::AuiNotebook#set_tab_kind}.
+    # 
+    # @wxrb_require USE_AUI
+    class AuiTabKind < Wx::Enum
+    
+      # Can be closed and dragged by user.
+      # 
+      Normal = Wx::AUI::AuiTabKind.new(0)
+      
+      # Can be closed and possibly unpinned by user.
+      # 
+      Pinned = Wx::AUI::AuiTabKind.new(1)
+      
+      # Can't be closed, dragged nor unlocked by user.
+      # 
+      Locked = Wx::AUI::AuiTabKind.new(2)
+      
+    end # AuiTabKind
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_PAGE_CLOSE = 10351
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_PAGE_CHANGED = 10354
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_PAGE_CHANGING = 10353
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_PAGE_CLOSED = 10352
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_BUTTON = 10355
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_BEGIN_DRAG = 10356
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_END_DRAG = 10357
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_DRAG_MOTION = 10359
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_ALLOW_DND = 10360
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN = 10364
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_TAB_MIDDLE_UP = 10363
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_TAB_RIGHT_DOWN = 10366
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_TAB_RIGHT_UP = 10365
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_DRAG_DONE = 10362
+    
+    # 
+    # 
+    EVT_AUINOTEBOOK_BG_DCLICK = 10361
+    
+    # This class is used by the events generated by {Wx::AUI::AuiNotebook}.
+    # 
+    # Please note that most events generated by {Wx::AUI::AuiNotebook} are handled by the notebook object itself, i.e. they do not propagate upwards to the notebook parent window, in spite of being command events. In order to handle these events you should use {Wx::EvtHandler#bind} to connect to the events on the notebook object itself and don't forget to use {Wx::Event#skip} to ensure that the notebook still processes them too.
+    # ### Events emitted by this class
+    # 
+    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::AUI::AuiNotebookEvent} events.
+    # Event handler methods for events emitted by this class:
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_close}(id, meth = nil, &block): A page is about to be closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSE} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_closed}(winid, meth = nil, &block): A page has been closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSED} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGED} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_button}(id, meth = nil, &block): The window list button has been pressed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BUTTON} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_begin_drag}(id, meth = nil, &block): Dragging is about to begin. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BEGIN_DRAG} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_end_drag}(id, meth = nil, &block): Dragging has ended. Processes a {Wx::AUI::EVT_AUINOTEBOOK_END_DRAG} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_drag_motion}(id, meth = nil, &block): Emitted during a drag and drop operation. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_MOTION} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_allow_dnd}(id, meth = nil, &block): Whether to allow a tab to be dropped. Processes a {Wx::AUI::EVT_AUINOTEBOOK_ALLOW_DND} event. This event must be specially allowed. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_drag_done}(winid, meth = nil, &block): Notify that the tab has been dragged. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_DONE} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_middle_down}(winid, meth = nil, &block): The middle mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_middle_up}(winid, meth = nil, &block): The middle mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_UP} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_right_down}(winid, meth = nil, &block): The right mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_DOWN} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_tab_right_up}(winid, meth = nil, &block): The right mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_UP} event. 
+    # 
+    # - {Wx::EvtHandler#evt_auinotebook_bg_dclick}(winid, meth = nil, &block): Double clicked on the tabs background area. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BG_DCLICK} event. 
+    # 
+    # Category:  {Wx::Events}, Book Controls
+    # @see Wx::AUI::AuiNotebook
+    # @see  Wx::BookCtrlEvent 
+    # 
+    # 
+    # @wxrb_require USE_AUI
+    class AuiNotebookEvent < BookCtrlEvent
+    
+      # Constructor.
+      # @param command_type [Wx::TipWindow::EventType] 
+      # @param win_id [Integer] 
+      # @return [Wx::AUI::AuiNotebookEvent]
+      def initialize(command_type=Wx::EVT_NULL, win_id=0) end
+      
+      # @return [Wx::Event]
+      def clone; end
+      
+    end # AuiNotebookEvent
+    
+
+  end
+
+end