wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,340 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # {Wx::AUI::AuiToolBarArt} is part of the {Wx::AUI} class framework and is the base class defining the interface for rendering {Wx::AUI::AuiToolBar}.
+    # 
+    # It is an abstract base class and its concrete {Wx::AuiGenericToolBarArt} and {Wx::AuiMSWToolBarArt} subclasses provide the implementations used by default under all non-MSW platforms and under MSW respectively.
+    # See also {Wx::AUI::AuiToolBar} and wxAUI Overview.
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiToolBarArt < ::Object
+    
+      # @return [Wx::AUI::AuiToolBarArt]
+      def initialize; end
+      
+      # @return [Wx::AUI::AuiToolBarArt]
+      def clone; end
+      
+      # @param flags [Integer] 
+      # @return [void]
+      def set_flags(flags) end
+      alias_method :flags=, :set_flags
+      
+      # @return [Integer]
+      def get_flags; end
+      alias_method :flags, :get_flags
+      
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [void]
+      def set_font(font) end
+      alias_method :font=, :set_font
+      
+      # @return [Wx::Font]
+      def get_font; end
+      alias_method :font, :get_font
+      
+      # @param orientation [Integer] 
+      # @return [void]
+      def set_text_orientation(orientation) end
+      alias_method :text_orientation=, :set_text_orientation
+      
+      # @return [Integer]
+      def get_text_orientation; end
+      alias_method :text_orientation, :get_text_orientation
+      
+      # Set the text direction for rendering text.
+      # 
+      # Does nothing in the base class, override this function to support vertical text rendering.
+      # @param direction [Wx::AuiTextDirection] 
+      # @return [void]
+      def set_text_direction(direction) end
+      alias_method :text_direction=, :set_text_direction
+      
+      # Return the direction used for rendering text.
+      # 
+      # Always returns {Wx::AUI::AuiTextDirection::LeftToRight} in the base class.
+      # @return [Wx::AuiTextDirection]
+      def get_text_direction; end
+      alias_method :text_direction, :get_text_direction
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_background(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_plain_background(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_label(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_button(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_drop_down_button(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_control_label(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_separator(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_gripper(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @param state [Integer] 
+      # @return [void]
+      def draw_overflow_button(dc, wnd, rect, state) end
+      
+      # Return the size of the label for the given item.
+      # 
+      # Note that the type of dc was {Wx::DC} until wxWidgets 3.3.0, where it was changed to {Wx::ReadOnlyDC} as this function doesn't modify the DC contents.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @return [Wx::Size]
+      def get_label_size(dc, wnd, item) end
+      alias_method :label_size, :get_label_size
+      
+      # Return the size of the given item.
+      # 
+      # Note that the type of dc was {Wx::DC} until wxWidgets 3.3.0, where it was changed to {Wx::ReadOnlyDC} as this function doesn't modify the DC contents.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @return [Wx::Size]
+      def get_tool_size(dc, wnd, item) end
+      alias_method :tool_size, :get_tool_size
+      
+      # Get the element size scaled by the DPI of the given window.
+      # 
+      # This function should be used to get the size of the element in pixels.
+      # The default version delegates to {Wx::AUI::AuiToolBarArt#get_element_size}, override this function if a different behaviour (e.g. to use some smarter algorithm for scaling instead of just multiplying by the DPI factor) is needed.
+      # 
+      # The size of the element in pixels.
+      # @see Wx::AUI::AuiToolBarArt#set_element_size
+      # @param elementId [Integer]  One of {Wx::AUI::AuiToolBarArtSetting} elements.
+      # @param window [Wx::Window]  A valid window, typically {Wx::AUI::AuiToolBar} itself.
+      # @return [Integer]
+      def get_element_size_for_window(elementId, window) end
+      alias_method :element_size_for_window, :get_element_size_for_window
+      
+      # Returns the size of the given element in DIPs.
+      # 
+      # This function is typically more convenient to override, as it can just return the same value as was passed to {Wx::AUI::AuiToolBarArt#set_element_size}, but it shouldn't usually be called, use {Wx::AUI::AuiToolBarArt#get_element_size_for_window} instead.
+      # 
+      # The size of the element in DIPs.
+      # @param elementId [Integer]  One of {Wx::AUI::AuiToolBarArtSetting} elements.
+      # @return [Integer]
+      def get_element_size(elementId) end
+      alias_method :element_size, :get_element_size
+      
+      # Sets the size of the given element in DIPs.
+      # 
+      # Note that this function takes the size in DPI-independent pixels and this size will be scaled by the factor depending on the DPI being actually used by {Wx::AUI::AuiToolBarArt#get_element_size_for_window}. In particular, do not use {Wx::Window#from_dip} for the size argument passed to this function.
+      # @param elementId [Integer]  One of {Wx::AUI::AuiToolBarArtSetting} elements.
+      # @param size [Integer]  The size of the element in DIPs.
+      # @return [void]
+      def set_element_size(elementId, size) end
+      
+      # Show a drop down menu with the given items.
+      # 
+      # ID of the item selected in the menu or -1 if the menu was dismissed
+      # @param wnd [Wx::Window] 
+      # @param items [Array<Wx::AUI::AuiToolBarItem>,nil] 
+      # @return [Integer]
+      def show_drop_down(wnd, items) end
+      
+    end # AuiToolBarArt
+    
+    # {Wx::AUI::AuiDefaultToolBarArt} is part of the {Wx::AUI} class framework.
+    # 
+    # See also {Wx::AUI::AuiToolBarArt} , {Wx::AUI::AuiToolBar} and wxAUI Overview.
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiDefaultToolBarArt < AuiToolBarArt
+    
+      # @return [Wx::AUI::AuiDefaultToolBarArt]
+      def initialize; end
+      
+      # @return [Wx::AUI::AuiToolBarArt]
+      def clone; end
+      
+      # @param flags [Integer] 
+      # @return [void]
+      def set_flags(flags) end
+      alias_method :flags=, :set_flags
+      
+      # @return [Integer]
+      def get_flags; end
+      alias_method :flags, :get_flags
+      
+      # @param font [Wx::Font,Wx::FontInfo] 
+      # @return [void]
+      def set_font(font) end
+      alias_method :font=, :set_font
+      
+      # @return [Wx::Font]
+      def get_font; end
+      alias_method :font, :get_font
+      
+      # @param orientation [Integer] 
+      # @return [void]
+      def set_text_orientation(orientation) end
+      alias_method :text_orientation=, :set_text_orientation
+      
+      # @return [Integer]
+      def get_text_orientation; end
+      alias_method :text_orientation, :get_text_orientation
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_background(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_plain_background(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_label(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_button(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_drop_down_button(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_control_label(dc, wnd, item, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_separator(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @return [void]
+      def draw_gripper(dc, wnd, rect) end
+      
+      # @param dc [Wx::DC] 
+      # @param wnd [Wx::Window] 
+      # @param rect [Wx::Rect] 
+      # @param state [Integer] 
+      # @return [void]
+      def draw_overflow_button(dc, wnd, rect, state) end
+      
+      # Return the size of the label for the given item.
+      # 
+      # Note that the type of dc was {Wx::DC} until wxWidgets 3.3.0, where it was changed to {Wx::ReadOnlyDC} as this function doesn't modify the DC contents.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @return [Wx::Size]
+      def get_label_size(dc, wnd, item) end
+      alias_method :label_size, :get_label_size
+      
+      # Return the size of the given item.
+      # 
+      # Note that the type of dc was {Wx::DC} until wxWidgets 3.3.0, where it was changed to {Wx::ReadOnlyDC} as this function doesn't modify the DC contents.
+      # @param dc [Wx::ReadOnlyDC] 
+      # @param wnd [Wx::Window] 
+      # @param item [Wx::AUI::AuiToolBarItem] 
+      # @return [Wx::Size]
+      def get_tool_size(dc, wnd, item) end
+      alias_method :tool_size, :get_tool_size
+      
+      # Return the size of the element.
+      # 
+      # Implement the base class pure virtual function by returning the default element size or the last value passed to {Wx::AUI::AuiDefaultToolBarArt#set_element_size}.
+      # @param elementId [Integer] 
+      # @return [Integer]
+      def get_element_size(elementId) end
+      alias_method :element_size, :get_element_size
+      
+      # Change the size of the element.
+      # 
+      # Implements the base class pure virtual function by storing the value to be returned by {Wx::AUI::AuiDefaultToolBarArt#get_element_size} and used by {Wx::AUI::AuiDefaultToolBarArt#get_element_size_for_window}.
+      # As for the base class function, size is in DIPs, not pixels, so {Wx::Window#from_dip} should not be used for it.
+      # @param elementId [Integer] 
+      # @param size [Integer] 
+      # @return [void]
+      def set_element_size(elementId, size) end
+      
+      # Show a drop down menu with the given items.
+      # 
+      # ID of the item selected in the menu or -1 if the menu was dismissed
+      # @param wnd [Wx::Window] 
+      # @param items [Array<Wx::AUI::AuiToolBarItem>,nil] 
+      # @return [Integer]
+      def show_drop_down(wnd, items) end
+      
+    end # AuiDefaultToolBarArt
+    
+
+  end
+
+end

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

@@ -0,0 +1,244 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # 
+    # 
+    EVT_AUITOOLBAR_TOOL_DROPDOWN = 10367
+    
+    # 
+    # 
+    EVT_AUITOOLBAR_OVERFLOW_CLICK = 10368
+    
+    # 
+    # 
+    EVT_AUITOOLBAR_RIGHT_CLICK = 10369
+    
+    # 
+    # 
+    EVT_AUITOOLBAR_MIDDLE_CLICK = 10370
+    
+    # 
+    # 
+    EVT_AUITOOLBAR_BEGIN_DRAG = 10371
+    
+    # {Wx::AUI::AuiToolBarStyle} is part of the {Wx::AUI} class framework, used to define the appearance of a {Wx::AUI::AuiToolBar}.
+    # 
+    # See also wxAUI Overview.
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiToolBarStyle < Wx::Enum
+    
+      # Shows the text in the toolbar buttons; by default only icons are shown.
+      # 
+      AUI_TB_TEXT = Wx::AUI::AuiToolBarStyle.new(1)
+      
+      # Don't show tooltips on {Wx::AUI::AuiToolBar} items.
+      # 
+      AUI_TB_NO_TOOLTIPS = Wx::AUI::AuiToolBarStyle.new(2)
+      
+      # Do not auto-resize the {Wx::AUI::AuiToolBar}.
+      # 
+      AUI_TB_NO_AUTORESIZE = Wx::AUI::AuiToolBarStyle.new(4)
+      
+      # Shows a gripper on the {Wx::AUI::AuiToolBar}.
+      # 
+      AUI_TB_GRIPPER = Wx::AUI::AuiToolBarStyle.new(8)
+      
+      # The {Wx::AUI::AuiToolBar} can contain overflow items.
+      # 
+      AUI_TB_OVERFLOW = Wx::AUI::AuiToolBarStyle.new(16)
+      
+      # Using this style forces the toolbar to be vertical and be only dockable to the left or right sides of the window whereas by default it can be horizontal or vertical and be docked anywhere.
+      # 
+      AUI_TB_VERTICAL = Wx::AUI::AuiToolBarStyle.new(32)
+      
+      # Shows the text and the icons alongside, not vertically stacked.
+      # 
+      AUI_TB_HORZ_LAYOUT = Wx::AUI::AuiToolBarStyle.new(64)
+      
+      # Analogous to {Wx::AUI::AuiToolBarStyle::AUI_TB_VERTICAL}, but forces the toolbar to be horizontal, docking to the top or bottom of the window.
+      # 
+      AUI_TB_HORIZONTAL = Wx::AUI::AuiToolBarStyle.new(128)
+      
+      # Draw a plain background (based on parent) instead of the default gradient background.
+      # 
+      AUI_TB_PLAIN_BACKGROUND = Wx::AUI::AuiToolBarStyle.new(256)
+      
+      # For vertical toolbars, put icon above vertical text.
+      # 
+      AUI_TB_VERT_LAYOUT_DOWN = Wx::AUI::AuiToolBarStyle.new(512)
+      
+      # For vertical toolbars, put icon below vertical text.
+      # 
+      AUI_TB_VERT_LAYOUT_UP = Wx::AUI::AuiToolBarStyle.new(1024)
+      
+      # Shows the text alongside the icons, not vertically stacked.
+      # 
+      AUI_TB_HORZ_TEXT = Wx::AUI::AuiToolBarStyle.new(65)
+      
+      # Shows the text for vertical toolbars, with icon above text.
+      # 
+      AUI_TB_VERT_TEXT_DOWN = Wx::AUI::AuiToolBarStyle.new(513)
+      
+      # Shows the text for vertical toolbars, with icon below text.
+      # 
+      AUI_TB_VERT_TEXT_UP = Wx::AUI::AuiToolBarStyle.new(1025)
+      
+      # Rotate the icon to match the text orientation.
+      # 
+      AUI_TB_ROTATE_ICON_WITH_TEXT = Wx::AUI::AuiToolBarStyle.new(2048)
+      
+      # Mask including both orientation flags.
+      # 
+      AUI_ORIENTATION_MASK = Wx::AUI::AuiToolBarStyle.new(160)
+      
+      # By default only icons are shown.
+      # 
+      AUI_TB_DEFAULT_STYLE = Wx::AUI::AuiToolBarStyle.new(0)
+      
+    end # AuiToolBarStyle
+    
+    # {Wx::AUI::AuiToolBarArtSetting}
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiToolBarArtSetting < Wx::Enum
+    
+      # {Wx::AUI::AuiToolBar} separator size.
+      # 
+      AUI_TBART_SEPARATOR_SIZE = Wx::AUI::AuiToolBarArtSetting.new(0)
+      
+      # {Wx::AUI::AuiToolBar} gripper size.
+      # 
+      AUI_TBART_GRIPPER_SIZE = Wx::AUI::AuiToolBarArtSetting.new(1)
+      
+      # Overflow button size in {Wx::AUI::AuiToolBar}.
+      # 
+      AUI_TBART_OVERFLOW_SIZE = Wx::AUI::AuiToolBarArtSetting.new(2)
+      
+      # Drop down button size in {Wx::AUI::AuiToolBar}.
+      # 
+      AUI_TBART_DROPDOWN_SIZE = Wx::AUI::AuiToolBarArtSetting.new(3)
+      
+    end # AuiToolBarArtSetting
+    
+    # {Wx::AUI::AuiToolBarToolTextOrientation}
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiToolBarToolTextOrientation < Wx::Enum
+    
+      # Text in {Wx::AUI::AuiToolBar} items is left aligned, currently unused/unimplemented.
+      # 
+      AUI_TBTOOL_TEXT_LEFT = Wx::AUI::AuiToolBarToolTextOrientation.new(0)
+      
+      # Text in {Wx::AUI::AuiToolBar} items is right aligned.
+      # 
+      AUI_TBTOOL_TEXT_RIGHT = Wx::AUI::AuiToolBarToolTextOrientation.new(1)
+      
+      # Text in {Wx::AUI::AuiToolBar} items is top aligned, currently unused/unimplemented.
+      # 
+      AUI_TBTOOL_TEXT_TOP = Wx::AUI::AuiToolBarToolTextOrientation.new(2)
+      
+      # Text in {Wx::AUI::AuiToolBar} items is bottom aligned.
+      # 
+      AUI_TBTOOL_TEXT_BOTTOM = Wx::AUI::AuiToolBarToolTextOrientation.new(3)
+      
+    end # AuiToolBarToolTextOrientation
+    
+    # Direction of the text in {Wx::AUI::AuiToolBar} items.
+    # 
+    # Horizontal toolbars always use LeftToRight direction, whereas vertical toolbars may use either TopToBottom or BottomToTop.
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiTextDirection < Wx::Enum
+    
+      # Default direction always used for horizontal toolbars.
+      # 
+      LeftToRight = Wx::AUI::AuiTextDirection.new(0)
+      
+      # May be used for vertical toolbars, typically on the right side.
+      # 
+      TopToBottom = Wx::AUI::AuiTextDirection.new(1)
+      
+      # May be used for vertical toolbars, typically on the left side.
+      # 
+      BottomToTop = Wx::AUI::AuiTextDirection.new(2)
+      
+    end # AuiTextDirection
+    
+    # {Wx::AUI::AuiToolBarEvent} is used for the events generated by {Wx::AUI::AuiToolBar}.
+    # 
+    # Category:  Window Docking (wxAUI), {Wx::Events}
+    # 
+    # @wxrb_require USE_AUI
+    class AuiToolBarEvent < NotifyEvent
+    
+      # @overload initialize(commandType=Wx::EVT_NULL, winId=0)
+      #   @param commandType [Wx::TipWindow::EventType] 
+      #   @param winId [Integer] 
+      #   @return [Wx::AUI::AuiToolBarEvent]
+      # @overload initialize(c)
+      #   @param c [Wx::AUI::AuiToolBarEvent] 
+      #   @return [Wx::AUI::AuiToolBarEvent]
+      def initialize(*args) end
+      
+      # Returns whether the drop down menu has been clicked.
+      # @return [Boolean]
+      def is_drop_down_clicked; end
+      alias_method :drop_down_clicked?, :is_drop_down_clicked
+      
+      # Returns the point where the user clicked with the mouse.
+      # @return [Wx::Point]
+      def get_click_point; end
+      alias_method :click_point, :get_click_point
+      
+      # Returns the {Wx::AUI::AuiToolBarItem} rectangle bounding the mouse click point.
+      # @return [Wx::Rect]
+      def get_item_rect; end
+      alias_method :item_rect, :get_item_rect
+      
+      # Returns the {Wx::AUI::AuiToolBarItem} identifier.
+      # @return [Integer]
+      def get_tool_id; end
+      alias_method :tool_id, :get_tool_id
+      
+      # @param c [Boolean] 
+      # @return [void]
+      def set_drop_down_clicked(c) end
+      alias_method :drop_down_clicked=, :set_drop_down_clicked
+      
+      # @param p [Array(Integer, Integer), Wx::Point] 
+      # @return [void]
+      def set_click_point(p) end
+      alias_method :click_point=, :set_click_point
+      
+      # @param r [Wx::Rect] 
+      # @return [void]
+      def set_item_rect(r) end
+      alias_method :item_rect=, :set_item_rect
+      
+      # @param toolId [Integer] 
+      # @return [void]
+      def set_tool_id(toolId) end
+      alias_method :tool_id=, :set_tool_id
+      
+    end # AuiToolBarEvent
+    
+
+  end
+
+end