wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,131 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # Event used to indicate various actions taken with {Wx::AUI::AuiManager}.
+    # 
+    # See {Wx::AUI::AuiManager} for available event types.
+    # ### Events using this class
+    # 
+    # The following event-handler methods redirect the events to member method or handler blocks for {Wx::AUI::AuiManagerEvent} events.
+    # Event handler methods:
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_button}(meth = nil, &block): Triggered when any button is pressed for any docked panes. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_close}(meth = nil, &block): Triggered when a docked or floating pane is closed. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_minimize}(meth = nil, &block): Triggered when a pane is minimized. This event is new since wxWidgets 3.3.2. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_maximize}(meth = nil, &block): Triggered when a pane is maximized. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_restore}(meth = nil, &block): Triggered when a pane is restored. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_pane_activated}(meth = nil, &block): Triggered when a pane is made 'active'. This event is new since wxWidgets 2.9.4. 
+    # 
+    # - {Wx::EvtHandler#evt_aui_render}(meth = nil, &block): This event can be caught to override the default renderer in order to custom draw your {Wx::AUI::AuiManager} window (not recommended). 
+    # 
+    # Category:  {Wx::Events}, Window Docking (wxAUI)
+    # @see Wx::AUI::AuiManager
+    # @see  Wx::AUI::AuiPaneInfo 
+    # 
+    # 
+    # @wxrb_require USE_AUI
+    class AuiManagerEvent < Event
+    
+      # Constructor.
+      # @param type [Wx::TipWindow::EventType] 
+      # @return [Wx::AUI::AuiManagerEvent]
+      def initialize(type=Wx::EVT_NULL) end
+      
+      # 
+      # 
+      # true if this event can be vetoed.
+      # @see Wx::AUI::AuiManagerEvent#veto 
+      # @return [Boolean]
+      def can_veto; end
+      alias_method :can_veto?, :can_veto
+      
+      # 
+      # 
+      # The ID of the button that was clicked.
+      # @return [Integer]
+      def get_button; end
+      alias_method :button, :get_button
+      
+      # 
+      # 
+      # TodoWhat is this?
+      # @return [Wx::DC]
+      def get_dc; end
+      alias_method :dc, :get_dc
+      
+      # 
+      # 
+      # true if this event was vetoed.
+      # @see Wx::AUI::AuiManagerEvent#veto 
+      # @return [Boolean]
+      def get_veto; end
+      
+      # 
+      # 
+      # The {Wx::AUI::AuiManager} this event is associated with.
+      # @return [Wx::AUI::AuiManager]
+      def get_manager; end
+      alias_method :manager, :get_manager
+      
+      # 
+      # 
+      # The pane this event is associated with.
+      # @return [Wx::AUI::AuiPaneInfo]
+      def get_pane; end
+      alias_method :pane, :get_pane
+      
+      # Sets the ID of the button clicked that triggered this event.
+      # @param button [Integer] 
+      # @return [void]
+      def set_button(button) end
+      alias_method :button=, :set_button
+      
+      # Sets whether or not this event can be vetoed.
+      # @param can_veto [Boolean] 
+      # @return [void]
+      def set_can_veto(can_veto) end
+      alias_method :can_veto=, :set_can_veto
+      
+      # 
+      # 
+      # TodoWhat is this?
+      # @param pdc [Wx::DC] 
+      # @return [void]
+      def set_dc(pdc) end
+      alias_method :dc=, :set_dc
+      
+      # Sets the {Wx::AUI::AuiManager} this event is associated with.
+      # @param manager [Wx::AUI::AuiManager] 
+      # @return [void]
+      def set_manager(manager) end
+      alias_method :manager=, :set_manager
+      
+      # Sets the pane this event is associated with.
+      # @param pane [Wx::AUI::AuiPaneInfo] 
+      # @return [void]
+      def set_pane(pane) end
+      alias_method :pane=, :set_pane
+      
+      # Cancels the action indicated by this event if {Wx::AUI::AuiManagerEvent#can_veto} is true.
+      # @param veto [Boolean] 
+      # @return [void]
+      def veto(veto=true) end
+      
+    end # AuiManagerEvent
+    
+
+  end
+
+end

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

@@ -0,0 +1,180 @@
+# :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 AuiMDIChildFrame < Panel
+    
+      # @overload initialize()
+      #   @return [Wx::AUI::AuiMDIChildFrame]
+      # @overload initialize(parent, winid, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR)
+      #   @param parent [Wx::AUI::AuiMDIParentFrame] 
+      #   @param winid [Integer] 
+      #   @param title [String] 
+      #   @param pos [Array(Integer, Integer), Wx::Point] 
+      #   @param size [Array(Integer, Integer), Wx::Size] 
+      #   @param style [Integer] 
+      #   @param name [String] 
+      #   @return [Wx::AUI::AuiMDIChildFrame]
+      # @overload initialize(parent, winid, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR, &block)
+      #   @param parent [Wx::AUI::AuiMDIParentFrame] 
+      #   @param winid [Integer] 
+      #   @param title [String] 
+      #   @param pos [Array(Integer, Integer), Wx::Point] 
+      #   @param size [Array(Integer, Integer), Wx::Size] 
+      #   @param style [Integer] 
+      #   @param name [String] 
+      #   @yieldparam [Wx::AUI::AuiMDIChildFrame] win new instance
+      #   @return [Wx::AUI::AuiMDIChildFrame]
+      def initialize(*args) end
+      
+      # @param parent [Wx::AUI::AuiMDIParentFrame] 
+      # @param winid [Integer] 
+      # @param title [String] 
+      # @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, winid, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end
+      
+      # @param menuBar [Wx::MenuBar] 
+      # @return [void]
+      def set_menu_bar(menuBar) end
+      alias_method :menu_bar=, :set_menu_bar
+      
+      # @return [Wx::MenuBar]
+      def get_menu_bar; end
+      alias_method :menu_bar, :get_menu_bar
+      
+      # @param title [String] 
+      # @return [void]
+      def set_title(title) end
+      alias_method :title=, :set_title
+      
+      # @return [String]
+      def get_title; end
+      alias_method :title, :get_title
+      
+      # @param icons [Wx::IconBundle] 
+      # @return [void]
+      def set_icons(icons) end
+      alias_method :icons=, :set_icons
+      
+      # @return [Wx::IconBundle]
+      def get_icons; end
+      alias_method :icons, :get_icons
+      
+      # @param icon [Wx::Icon] 
+      # @return [void]
+      def set_icon(icon) end
+      alias_method :icon=, :set_icon
+      
+      # @return [void]
+      def activate; end
+      
+      # Destroys the window safely.
+      # 
+      # Use this function instead of the delete operator, since different window classes can be destroyed differently. Frames and dialogs are not destroyed immediately when this function is called  they are added to a list of windows to be deleted on idle time, when all the window's events have been processed. This prevents problems with events being sent to non-existent windows.
+      # true if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion.
+      # @return [Boolean]
+      def destroy; end
+      
+      # Shows or hides the window.
+      # 
+      # You may need to call {Wx::AUI::AuiMDIChildFrame#raise} for a top level window if you want to bring it to top, although this is not needed if {Wx::AUI::AuiMDIChildFrame#show} is called immediately after the frame creation.
+      # Notice that the default state of newly created top level windows is hidden (to allow you to create their contents without flicker) unlike for all the other, not derived from {Wx::TopLevelWindow}, windows that are by default created in the shown state.
+      # 
+      # true if the window has been shown or hidden or false if nothing was done because it already was in the requested state.
+      # @see Wx::AUI::AuiMDIChildFrame#is_shown
+      # @see  Wx::AUI::AuiMDIChildFrame#hide
+      # @see  Wx::RadioBox#show
+      # @see  Wx::ShowEvent. 
+      # @param show [Boolean]  If true displays the window. Otherwise, hides it.
+      # @return [Boolean]
+      def show(show=true) end
+      
+      # @param number [Integer] 
+      # @param style [Integer] 
+      # @param winid [Integer] 
+      # @param name [String] 
+      # @return [Wx::StatusBar]
+      def create_status_bar(number=1, style=1, winid=1, name=('')) end
+      
+      # @return [Wx::StatusBar]
+      def get_status_bar; end
+      alias_method :status_bar, :get_status_bar
+      
+      # @param text [String] 
+      # @param number [Integer] 
+      # @return [void]
+      def set_status_text(text, number=0) end
+      alias_method :status_text=, :set_status_text
+      
+      # @param widths_field [Array<Integer>] 
+      # @return [void]
+      def set_status_widths(widths_field) end
+      
+      # @param style [Integer] 
+      # @param winid [Integer] 
+      # @param name [String] 
+      # @return [Wx::ToolBar]
+      def create_tool_bar(style, winid, name) end
+      
+      # @return [Wx::ToolBar]
+      def get_tool_bar; end
+      alias_method :tool_bar, :get_tool_bar
+      
+      # @param maximize [Boolean] 
+      # @return [void]
+      def maximize(maximize=true) end
+      
+      # @return [void]
+      def restore; end
+      
+      # @param iconize [Boolean] 
+      # @return [void]
+      def iconize(iconize=true) end
+      
+      # @return [Boolean]
+      def is_maximized; end
+      alias_method :maximized?, :is_maximized
+      
+      # @return [Boolean]
+      def is_iconized; end
+      alias_method :iconized?, :is_iconized
+      
+      # @param show [Boolean] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def show_full_screen(show, style) end
+      
+      # @return [Boolean]
+      def is_full_screen; end
+      alias_method :full_screen?, :is_full_screen
+      
+      # @param parent [Wx::AUI::AuiMDIParentFrame] 
+      # @return [void]
+      def set_mdi_parent_frame(parent) end
+      alias_method :mdi_parent_frame=, :set_mdi_parent_frame
+      
+      # @return [Wx::AUI::AuiMDIParentFrame]
+      def get_mdi_parent_frame; end
+      alias_method :mdi_parent_frame, :get_mdi_parent_frame
+      
+    end # AuiMDIChildFrame
+    
+
+  end
+
+end

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

@@ -0,0 +1,59 @@
+# :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 AuiMDIClientWindow < BookCtrlBase
+    
+      # @overload initialize()
+      #   @return [Wx::AUI::AuiMDIClientWindow]
+      # @overload initialize(parent, style=0)
+      #   @param parent [Wx::AUI::AuiMDIParentFrame] 
+      #   @param style [Integer] 
+      #   @return [Wx::AUI::AuiMDIClientWindow]
+      # @overload initialize(parent, style=0, &block)
+      #   @param parent [Wx::AUI::AuiMDIParentFrame] 
+      #   @param style [Integer] 
+      #   @yieldparam [Wx::AUI::AuiMDIClientWindow] win new instance
+      #   @return [Wx::AUI::AuiMDIClientWindow]
+      def initialize(*args) end
+      
+      # @param parent [Wx::AUI::AuiMDIParentFrame] 
+      # @param style [Integer] 
+      # @return [Boolean]
+      def create_client(parent, style=(Wx::VSCROLL|Wx::HSCROLL)) end
+      
+      # Sets the selection to the given page, returning the previous selection.
+      # 
+      # Notice that the call to this function generates the page changing events, use the {Wx::AUI::AuiMDIClientWindow#change_selection} function if you don't want these events to be generated.
+      # @see Wx::AUI::AuiMDIClientWindow#get_selection 
+      # @param page [Integer] 
+      # @return [Integer]
+      def set_selection(page) end
+      alias_method :selection=, :set_selection
+      
+      # @return [Wx::AUI::AuiMDIChildFrame]
+      def get_active_child; end
+      alias_method :active_child, :get_active_child
+      
+      # @param pChildFrame [Wx::AUI::AuiMDIChildFrame] 
+      # @return [void]
+      def set_active_child(pChildFrame) end
+      alias_method :active_child=, :set_active_child
+      
+    end # AuiMDIClientWindow
+    
+
+  end
+
+end

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

@@ -0,0 +1,130 @@
+# :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 AuiMDIParentFrame < Frame
+    
+      # @overload initialize()
+      #   @return [Wx::AUI::AuiMDIParentFrame]
+      # @overload initialize(parent, winid, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DEFAULT_FRAME_STYLE|Wx::VSCROLL|Wx::HSCROLL), name=Wx::FRAME_NAME_STR)
+      #   @param parent [Wx::Window] 
+      #   @param winid [Integer] 
+      #   @param title [String] 
+      #   @param pos [Array(Integer, Integer), Wx::Point] 
+      #   @param size [Array(Integer, Integer), Wx::Size] 
+      #   @param style [Integer] 
+      #   @param name [String] 
+      #   @return [Wx::AUI::AuiMDIParentFrame]
+      # @overload initialize(parent, winid, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DEFAULT_FRAME_STYLE|Wx::VSCROLL|Wx::HSCROLL), name=Wx::FRAME_NAME_STR, &block)
+      #   @param parent [Wx::Window] 
+      #   @param winid [Integer] 
+      #   @param title [String] 
+      #   @param pos [Array(Integer, Integer), Wx::Point] 
+      #   @param size [Array(Integer, Integer), Wx::Size] 
+      #   @param style [Integer] 
+      #   @param name [String] 
+      #   @yieldparam [Wx::AUI::AuiMDIParentFrame] win new instance
+      #   @return [Wx::AUI::AuiMDIParentFrame]
+      def initialize(*args) end
+      
+      # @param parent [Wx::Window] 
+      # @param winid [Integer] 
+      # @param title [String] 
+      # @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, winid, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=(Wx::DEFAULT_FRAME_STYLE|Wx::VSCROLL|Wx::HSCROLL), name=Wx::FRAME_NAME_STR) end
+      
+      # @param provider [Wx::AUI::AuiTabArt] 
+      # @return [void]
+      def set_art_provider(provider) end
+      alias_method :art_provider=, :set_art_provider
+      
+      # @return [Wx::AUI::AuiTabArt]
+      def get_art_provider; end
+      alias_method :art_provider, :get_art_provider
+      
+      # @return [Wx::AUI::AuiNotebook]
+      def get_notebook; end
+      alias_method :notebook, :get_notebook
+      
+      # @return [Wx::Menu]
+      def get_window_menu; end
+      alias_method :window_menu, :get_window_menu
+      
+      # @param pMenu [Wx::Menu] 
+      # @return [void]
+      def set_window_menu(pMenu) end
+      alias_method :window_menu=, :set_window_menu
+      
+      # Tells the frame to show the given menu bar.
+      # 
+      # <div class="wxrb-remark">
+      # <b>Remark:</b>
+      # <p>If the frame is destroyed, the menu bar and its menus will be destroyed also, so do not delete the menu bar explicitly (except by resetting the frame's menu bar to another frame or nil). Under Windows, a size event is generated, so be sure to initialize data members properly before calling {Wx::AUI::AuiMDIParentFrame#set_menu_bar}. Note that on some platforms, it is not possible to call this function twice for the same frame object.
+      # </p>
+      # </div>
+      # @see Wx::AUI::AuiMDIParentFrame#get_menu_bar
+      # @see  Wx::MenuBar
+      # @see  Wx::Menu. 
+      # @param menuBar [Wx::MenuBar]  The menu bar to associate with the frame.
+      # @return [void]
+      def set_menu_bar(menuBar) end
+      alias_method :menu_bar=, :set_menu_bar
+      
+      # @param pChild [Wx::AUI::AuiMDIChildFrame] 
+      # @return [void]
+      def set_child_menu_bar(pChild) end
+      alias_method :child_menu_bar=, :set_child_menu_bar
+      
+      # @return [Wx::AUI::AuiMDIChildFrame]
+      def get_active_child; end
+      alias_method :active_child, :get_active_child
+      
+      # @param pChildFrame [Wx::AUI::AuiMDIChildFrame] 
+      # @return [void]
+      def set_active_child(pChildFrame) end
+      alias_method :active_child=, :set_active_child
+      
+      # @return [Wx::AUI::AuiMDIClientWindow]
+      def get_client_window; end
+      alias_method :client_window, :get_client_window
+      
+      # @return [Wx::AUI::AuiMDIClientWindow]
+      def on_create_client; end
+      
+      # @return [void]
+      def cascade; end
+      
+      # @param orient [Wx::Orientation] 
+      # @return [void]
+      def tile(orient=Wx::Orientation::HORIZONTAL) end
+      
+      # @return [void]
+      def arrange_icons; end
+      
+      # @return [void]
+      def activate_next; end
+      
+      # @return [void]
+      def activate_previous; end
+      
+    end # AuiMDIParentFrame
+    
+
+  end
+
+end