wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,352 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # Wx::AUI::AuiDefaultTabArt is an alias for the tab art provider used by {Wx::AUI::AuiNotebook} by default.
+    # Since wxWidgets 3.3.0, this is {Wx::AUI::AuiFlatTabArt} under all platforms. In the previous versions, this was wxAuiNativeTabArt.
+    AuiDefaultTabArt = Wx::AUI::AuiFlatTabArt
+    
+    # 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 class {Wx::AUI::AuiDefaultTabArt}, derived from this class, which provides bitmaps 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)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiTabArt < ::Object
+    
+      # Constructor.
+      # @return [Wx::AUI::AuiTabArt]
+      def initialize; end
+      
+      # Clones the art object.
+      # @return [Wx::AUI::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.
+      # 
+      # This function used to be pure virtual and so had to be overridden in the derived classes in the previous versions of wxWidgets, however since version 3.3.0 it doesn't have to be overridden if {Wx::AUI::AuiTabArt#draw_page_tab} is overridden and, moreover, it is recommended to override {Wx::AUI::AuiTabArt#draw_page_tab} instead of this function in the new code.
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param page [Wx::AUI::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 tab for the specified notebook page.
+      # 
+      # This function must be overridden if {Wx::AUI::AuiTabArt#draw_tab} is not overridden and, also, if pinned tabs are used, as they are not supported by {Wx::AUI::AuiTabArt#draw_tab}.
+      # The pane contains the information about the page to draw, in particular its {Wx::AUI::AuiNotebookPage::buttons} specifies the buttons to draw if it is not empty and receives the rectangles where they were drawn on output in the Wx::AuiTabContainerButton::rect fields.
+      # Note that if a button state is {Wx::AUI::AuiPaneButtonState::AUI_BUTTON_STATE_HIDDEN}, the effect is the same as not including this button at all, i.e. it is not drawn and the output field is not modified in this case.
+      # The {Wx::AUI::AuiNotebookPage::rect} field is also updated by this function to contain the bounding rectangle of the tab.
+      # The total horizontal span of the tab, which may be greater than the page bounding rectangle.
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param page [Wx::AUI::AuiNotebookPage] 
+      # @param rect [Wx::Rect] 
+      # @return [Integer]
+      def draw_page_tab(dc, wnd, page, rect) end
+      
+      # Returns the tab control size.
+      # @param arg [Wx::Window] 
+      # @param arg1 [Array<Wx::AUI::AuiNotebookPage>] 
+      # @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 font to use for normal, non-selected, tabs.
+      # 
+      # By default, returns an invalid font, meaning that the font set for {Wx::AUI::AuiNotebook} itself should be used.
+      # This function should be overridden for {Wx::AUI::AuiTabArt#set_normal_font} to actually work.
+      # @return [Wx::Font]
+      def get_normal_font; end
+      alias_method :normal_font, :get_normal_font
+      
+      # Returns the font to use for the selected tab.
+      # 
+      # By default, returns an invalid font, meaning that the font set for {Wx::AUI::AuiNotebook} itself should be used.
+      # This function should be overridden for {Wx::AUI::AuiTabArt#set_selected_font} to actually work.
+      # @return [Wx::Font]
+      def get_selected_font; end
+      alias_method :selected_font, :get_selected_font
+      
+      # Returns the tab size for the given caption, bitmap and state.
+      # 
+      # This function used to be pure virtual and so had to be overridden in the derived classes in the previous versions of wxWidgets, however since version 3.3.0 it doesn't have to be overridden if {Wx::AUI::AuiTabArt#get_page_tab_size} is overridden and it is recommended to override {Wx::AUI::AuiTabArt#get_page_tab_size} instead of this function in the new code.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param caption [String] 
+      # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      # @param active [Boolean] 
+      # @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
+      
+      # Returns the size of the tab for the specified notebook page.
+      # 
+      # This function must be overridden if {Wx::AUI::AuiTabArt#get_tab_size} is not overridden and, also, if pinned tabs are used, as they are not supported by {Wx::AUI::AuiTabArt#get_tab_size}.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param page [Wx::AUI::AuiNotebookPage] 
+      # @return [Array(Wx::Size,Integer)]
+      def get_page_tab_size(dc, wnd, page) end
+      alias_method :page_tab_size, :get_page_tab_size
+      
+      # Returns the rectangle for the given button.
+      # 
+      # This function is not pure virtual because it is only for multi-line tabs, but it must be implemented if {Wx::AUI::AuiNotebookOption::AUI_NB_MULTILINE} is used.
+      # If specified, the returned rectangle must be filled with the same value as {Wx::AUI::AuiTabArt#draw_button} puts into its outRect but here it can also be null in which case just its width is returned.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param inRect [Wx::Rect] 
+      # @param bitmapId [Integer] 
+      # @param buttonState [Integer] 
+      # @param orientation [Integer] 
+      # @param outRect [Wx::Rect] 
+      # @return [Integer]
+      def get_button_rect(dc, wnd, inRect, bitmapId, buttonState, orientation, outRect=nil) end
+      alias_method :button_rect, :get_button_rect
+      
+      # 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.
+      # 
+      # 
+      # @see Wx::AUI::AuiTabArt#get_normal_font 
+      # @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.
+      # 
+      # 
+      # @see Wx::AUI::AuiTabArt#get_selected_font 
+      # @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 nil 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
+    
+    # An art provider for {Wx::AUI::AuiNotebook} implementing "flat" look.
+    # 
+    # This art provider is currently used as the default art provider.
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiFlatTabArt < AuiTabArt
+    
+      # Default constructor.
+      # @return [Wx::AUI::AuiFlatTabArt]
+      def initialize; end
+      
+    end # AuiFlatTabArt
+    
+    # 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)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiSimpleTabArt < AuiTabArt
+    
+      # @return [Wx::AUI::AuiSimpleTabArt]
+      def initialize; end
+      
+      # Clones the art object.
+      # @return [Wx::AUI::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 nil 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.
+      # 
+      # 
+      # @see Wx::AUI::AuiSimpleTabArt#get_normal_font 
+      # @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.
+      # 
+      # 
+      # @see Wx::AUI::AuiSimpleTabArt#get_selected_font 
+      # @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.
+      # 
+      # This function used to be pure virtual and so had to be overridden in the derived classes in the previous versions of wxWidgets, however since version 3.3.0 it doesn't have to be overridden if {Wx::AUI::AuiSimpleTabArt#draw_page_tab} is overridden and, moreover, it is recommended to override {Wx::AUI::AuiSimpleTabArt#draw_page_tab} instead of this function in the new code.
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param page [Wx::AUI::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::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param caption [String] 
+      # @param bitmap [Wx::Bitmap] 
+      # @param active [Boolean] 
+      # @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 [Array<Wx::AUI::AuiNotebookPage>] 
+      # @param activeIdx [Integer] 
+      # @return [Integer]
+      def show_drop_down(wnd, items, activeIdx) end
+      
+      # Returns the tab control size.
+      # @param arg [Wx::Window] 
+      # @param arg1 [Array<Wx::AUI::AuiNotebookPage>] 
+      # @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
+    
+    # Wx::AUI::AuiNativeTabArt is either an art provider providing native-like appearance (WXMSW and WXGTK) or a generic Tab Art provider if not available.
+    class AuiNativeTabArt < AuiTabArt; end
+    
+
+  end
+
+end

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

@@ -0,0 +1,14 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+
+  end
+
+end