wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,372 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::AUI
+
+  # Tab art provider defines all the drawing functions used by {Wx::AUI::AuiNotebook}.
+  # This allows the {Wx::AUI::AuiNotebook} to have a pluggable look-and-feel.
+  # By default, a {Wx::AUI::AuiNotebook} uses an instance of this class called {Wx::AUI::AuiDefaultTabArt} which provides bitmap art and a colour scheme that is adapted to the major platforms' look. You can either derive from that class to alter its behaviour or write a completely new tab art class.
+  # Another example of creating a new {Wx::AUI::AuiNotebook} tab bar is {Wx::AUI::AuiSimpleTabArt}.
+  # Call {Wx::AUI::AuiNotebook#set_art_provider} to make use of this new tab art.
+  # === 
+  # 
+  # Category:  Window Docking (wxAUI)
+  # 
+  class AuiTabArt < ::Object
+  
+    # Constructor.
+    # @return [AuiTabArt]
+    def initialize; end
+    
+    # Clones the art object.
+    # @return [Wx::AuiTabArt]
+    def clone; end
+    
+    # Draws a background on the given area.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def draw_background(dc, wnd, rect) end
+    
+    # Draws a button.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param in_rect [Wx::Rect] 
+    # @param bitmap_id [Integer] 
+    # @param button_state [Integer] 
+    # @param orientation [Integer] 
+    # @param out_rect [Wx::Rect] 
+    # @return [void]
+    def draw_button(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect) end
+    
+    # Draws a tab.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param page [Wx::AuiNotebookPage] 
+    # @param rect [Wx::Rect] 
+    # @param close_button_state [Integer] 
+    # @param out_tab_rect [Wx::Rect] 
+    # @param out_button_rect [Wx::Rect] 
+    # @return [Integer]
+    def draw_tab(dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect) end
+    
+    # Returns the tab control size.
+    # @param arg [Wx::Window] 
+    # @param arg1 [Wx::AuiNotebookPageArray] 
+    # @param arg2 [Array(Integer, Integer), Wx::Size] 
+    # @return [Integer]
+    def get_best_tab_ctrl_size(arg, arg1, arg2) end
+    alias_method :best_tab_ctrl_size, :get_best_tab_ctrl_size
+    
+    # Returns the indent size.
+    # @return [Integer]
+    def get_indent_size; end
+    alias_method :indent_size, :get_indent_size
+    
+    # Returns the tab size for the given caption, bitmap and state.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param caption [String] 
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param active [true,false] 
+    # @param close_button_state [Integer] 
+    # @return [Array(Wx::Size,Integer)]
+    def get_tab_size(dc, wnd, caption, bitmap, active, close_button_state) end
+    alias_method :tab_size, :get_tab_size
+    
+    # Sets flags.
+    # @param flags [Integer] 
+    # @return [void]
+    def set_flags(flags) end
+    alias_method :flags=, :set_flags
+    
+    # Sets the font used for calculating measurements.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_measuring_font(font) end
+    alias_method :measuring_font=, :set_measuring_font
+    
+    # Sets the normal font for drawing labels.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_normal_font(font) end
+    alias_method :normal_font=, :set_normal_font
+    
+    # Sets the font for drawing text for selected UI elements.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_selected_font(font) end
+    alias_method :selected_font=, :set_selected_font
+    
+    # Sets the colour of the inactive tabs.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(colour) end
+    alias_method :colour=, :set_colour
+    
+    # Sets the colour of the selected tab.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_active_colour(colour) end
+    alias_method :active_colour=, :set_active_colour
+    
+    # Sets sizing information.
+    # The wnd argument is only present in wxWidgets 3.1.6 and newer and is required, it only has NULL default value for compatibility reasons.
+    # @param tab_ctrl_size [Array(Integer, Integer), Wx::Size] 
+    # @param tab_count [Integer] 
+    # @param wnd [Wx::Window] 
+    # @return [void]
+    def set_sizing_info(tab_ctrl_size, tab_count, wnd=nil) end
+    
+  end # AuiTabArt
+  
+  # Default art provider for {Wx::AUI::AuiNotebook}.
+  # <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
+  #   </td></tr></table></div>
+  # === 
+  # 
+  # Category:  Window Docking (wxAUI)
+  # @see Wx::AUI::AuiTabArt
+  # 
+  # 
+  class AuiDefaultTabArt < AuiTabArt
+  
+    # @return [AuiDefaultTabArt]
+    def initialize; end
+    
+    # Clones the art object.
+    # @return [Wx::AuiTabArt]
+    def clone; end
+    
+    # Sets flags.
+    # @param flags [Integer] 
+    # @return [void]
+    def set_flags(flags) end
+    alias_method :flags=, :set_flags
+    
+    # Sets sizing information.
+    # The wnd argument is only present in wxWidgets 3.1.6 and newer and is required, it only has NULL default value for compatibility reasons.
+    # @param tab_ctrl_size [Array(Integer, Integer), Wx::Size] 
+    # @param tab_count [Integer] 
+    # @param wnd [Wx::Window] 
+    # @return [void]
+    def set_sizing_info(tab_ctrl_size, tab_count, wnd=nil) end
+    
+    # Sets the normal font for drawing labels.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_normal_font(font) end
+    alias_method :normal_font=, :set_normal_font
+    
+    # Sets the font for drawing text for selected UI elements.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_selected_font(font) end
+    alias_method :selected_font=, :set_selected_font
+    
+    # Sets the font used for calculating measurements.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_measuring_font(font) end
+    alias_method :measuring_font=, :set_measuring_font
+    
+    # Sets the colour of the inactive tabs.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(colour) end
+    alias_method :colour=, :set_colour
+    
+    # Sets the colour of the selected tab.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_active_colour(colour) end
+    alias_method :active_colour=, :set_active_colour
+    
+    # Draws a background on the given area.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def draw_background(dc, wnd, rect) end
+    
+    # Draws a tab.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param page [Wx::AuiNotebookPage] 
+    # @param rect [Wx::Rect] 
+    # @param close_button_state [Integer] 
+    # @param out_tab_rect [Wx::Rect] 
+    # @param out_button_rect [Wx::Rect] 
+    # @return [Integer]
+    def draw_tab(dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect) end
+    
+    # Draws a button.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param in_rect [Wx::Rect] 
+    # @param bitmap_id [Integer] 
+    # @param button_state [Integer] 
+    # @param orientation [Integer] 
+    # @param out_rect [Wx::Rect] 
+    # @return [void]
+    def draw_button(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect) end
+    
+    # Returns the indent size.
+    # @return [Integer]
+    def get_indent_size; end
+    alias_method :indent_size, :get_indent_size
+    
+    # Returns the tab size for the given caption, bitmap and state.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param caption [String] 
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @param active [true,false] 
+    # @param close_button_state [Integer] 
+    # @return [Array(Wx::Size,Integer)]
+    def get_tab_size(dc, wnd, caption, bitmap, active, close_button_state) end
+    alias_method :tab_size, :get_tab_size
+    
+    # @param wnd [Wx::Window] 
+    # @param items [Wx::AuiNotebookPageArray] 
+    # @param activeIdx [Integer] 
+    # @return [Integer]
+    def show_drop_down(wnd, items, activeIdx) end
+    
+    # Returns the tab control size.
+    # @param arg [Wx::Window] 
+    # @param arg1 [Wx::AuiNotebookPageArray] 
+    # @param arg2 [Array(Integer, Integer), Wx::Size] 
+    # @return [Integer]
+    def get_best_tab_ctrl_size(arg, arg1, arg2) end
+    alias_method :best_tab_ctrl_size, :get_best_tab_ctrl_size
+    
+  end # AuiDefaultTabArt
+  
+  # Another standard tab art provider for {Wx::AUI::AuiNotebook}.
+  # {Wx::AUI::AuiSimpleTabArt} is derived from {Wx::AUI::AuiTabArt} demonstrating how to write a completely new tab art class. It can also be used as alternative to {Wx::AUI::AuiDefaultTabArt}.
+  #  <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
+  #   </td></tr></table></div>
+  # === 
+  # 
+  # Category:  Window Docking (wxAUI)
+  # 
+  class AuiSimpleTabArt < AuiTabArt
+  
+    # @return [AuiSimpleTabArt]
+    def initialize; end
+    
+    # Clones the art object.
+    # @return [Wx::AuiTabArt]
+    def clone; end
+    
+    # Sets flags.
+    # @param flags [Integer] 
+    # @return [void]
+    def set_flags(flags) end
+    alias_method :flags=, :set_flags
+    
+    # Sets sizing information.
+    # The wnd argument is only present in wxWidgets 3.1.6 and newer and is required, it only has NULL default value for compatibility reasons.
+    # @param tab_ctrl_size [Array(Integer, Integer), Wx::Size] 
+    # @param tab_count [Integer] 
+    # @param wnd [Wx::Window] 
+    # @return [void]
+    def set_sizing_info(tab_ctrl_size, tab_count, wnd=nil) end
+    
+    # Sets the normal font for drawing labels.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_normal_font(font) end
+    alias_method :normal_font=, :set_normal_font
+    
+    # Sets the font for drawing text for selected UI elements.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_selected_font(font) end
+    alias_method :selected_font=, :set_selected_font
+    
+    # Sets the font used for calculating measurements.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_measuring_font(font) end
+    alias_method :measuring_font=, :set_measuring_font
+    
+    # Sets the colour of the inactive tabs.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(colour) end
+    alias_method :colour=, :set_colour
+    
+    # Sets the colour of the selected tab.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_active_colour(colour) end
+    alias_method :active_colour=, :set_active_colour
+    
+    # Draws a background on the given area.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param rect [Wx::Rect] 
+    # @return [void]
+    def draw_background(dc, wnd, rect) end
+    
+    # Draws a tab.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param page [Wx::AuiNotebookPage] 
+    # @param rect [Wx::Rect] 
+    # @param close_button_state [Integer] 
+    # @param out_tab_rect [Wx::Rect] 
+    # @param out_button_rect [Wx::Rect] 
+    # @return [Integer]
+    def draw_tab(dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect) end
+    
+    # Draws a button.
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param in_rect [Wx::Rect] 
+    # @param bitmap_id [Integer] 
+    # @param button_state [Integer] 
+    # @param orientation [Integer] 
+    # @param out_rect [Wx::Rect] 
+    # @return [void]
+    def draw_button(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect) end
+    
+    # Returns the indent size.
+    # @return [Integer]
+    def get_indent_size; end
+    alias_method :indent_size, :get_indent_size
+    
+    # @param dc [Wx::DC] 
+    # @param wnd [Wx::Window] 
+    # @param caption [String] 
+    # @param bitmap [Wx::Bitmap] 
+    # @param active [true,false] 
+    # @param closeButtonState [Integer] 
+    # @return [Array(Wx::Size,Integer)]
+    def get_tab_size(dc, wnd, caption, bitmap, active, closeButtonState) end
+    alias_method :tab_size, :get_tab_size
+    
+    # @param wnd [Wx::Window] 
+    # @param items [Wx::AuiNotebookPageArray] 
+    # @param activeIdx [Integer] 
+    # @return [Integer]
+    def show_drop_down(wnd, items, activeIdx) end
+    
+    # Returns the tab control size.
+    # @param arg [Wx::Window] 
+    # @param arg1 [Wx::AuiNotebookPageArray] 
+    # @param arg2 [Array(Integer, Integer), Wx::Size] 
+    # @return [Integer]
+    def get_best_tab_ctrl_size(arg, arg1, arg2) end
+    alias_method :best_tab_ctrl_size, :get_best_tab_ctrl_size
+    
+  end # AuiSimpleTabArt
+  
+
+end

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

@@ -0,0 +1,147 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx::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_DEFAULT_STYLE = Wx::AUI::AuiNotebookOption.new(10545)
+    
+  end # AuiNotebookOption
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_PAGE_CLOSE = 10411
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_PAGE_CHANGED = 10414
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_PAGE_CHANGING = 10413
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_PAGE_CLOSED = 10412
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_BUTTON = 10415
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_BEGIN_DRAG = 10416
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_END_DRAG = 10417
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_DRAG_MOTION = 10419
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_ALLOW_DND = 10420
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN = 10424
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_TAB_MIDDLE_UP = 10423
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_TAB_RIGHT_DOWN = 10426
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_TAB_RIGHT_UP = 10425
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_DRAG_DONE = 10422
+  
+  # 
+  # 
+  EVT_AUINOTEBOOK_BG_DCLICK = 10421
+  
+  # A simple class which holds information about {Wx::AUI::AuiNotebook} tab buttons and their state.
+  # === 
+  # 
+  # Category:  Window Docking (wxAUI)
+  # 
+  class AuiTabContainerButton < ::Object
+  
+  end # AuiTabContainerButton
+  
+
+end