wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,257 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  module AUI
+
+    # {Wx::AUI::AuiToolBarItem} is part of the {Wx::AUI} class framework, representing a toolbar element.
+    # 
+    # See also {Wx::AUI::AuiToolBar} and wxAUI Overview.
+    # It has a unique id (except for the separators which always have id = -1), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar (currently not implemented).
+    # 
+    # Category:  Window Docking (wxAUI)
+    # 
+    # @wxrb_require USE_AUI
+    class AuiToolBarItem < ::Object
+    
+      # @overload initialize()
+      #   Default Constructor.
+      #   @return [Wx::AUI::AuiToolBarItem]
+      # @overload initialize(c)
+      #   Assigns the properties of the {Wx::AUI::AuiToolBarItem} "c" to this.
+      #   @param c [Wx::AUI::AuiToolBarItem] 
+      #   @return [Wx::AUI::AuiToolBarItem]
+      def initialize(*args) end
+      
+      # Assigns the properties of the {Wx::AUI::AuiToolBarItem} "c" to this.
+      # @param c [Wx::AUI::AuiToolBarItem] 
+      # @return [void]
+      def assign(c) end
+      
+      # Assigns a window to the toolbar item.
+      # @param w [Wx::Window] 
+      # @return [void]
+      def set_window(w) end
+      alias_method :window=, :set_window
+      
+      # Returns the {Wx::Window}* associated to the toolbar item.
+      # @return [Wx::Window]
+      def get_window; end
+      alias_method :window, :get_window
+      
+      # Sets the toolbar item identifier.
+      # @param new_id [Integer] 
+      # @return [void]
+      def set_id(new_id) end
+      alias_method :id=, :set_id
+      
+      # Returns the toolbar item identifier.
+      # @return [Integer]
+      def get_id; end
+      alias_method :id, :get_id
+      
+      # Sets the {Wx::AUI::AuiToolBarItem} kind.
+      # @param new_kind [Integer] 
+      # @return [void]
+      def set_kind(new_kind) end
+      alias_method :kind=, :set_kind
+      
+      # Returns the toolbar item kind.
+      # 
+      # one of {Wx::ItemKind::ITEM_NORMAL}, {Wx::ItemKind::ITEM_CHECK} or {Wx::ItemKind::ITEM_RADIO}, {Wx::ItemKind::ITEM_SEPARATOR}, {Wx::ITEM_CONTROL}, {Wx::ITEM_SPACER}, {Wx::ITEM_LABEL},
+      # @return [Integer]
+      def get_kind; end
+      alias_method :kind, :get_kind
+      
+      # Set the current state of the toolbar item.
+      # @param new_state [Integer]  is an or'd combination of flags from {Wx::AUI::AuiPaneButtonState}
+      # @return [void]
+      def set_state(new_state) end
+      alias_method :state=, :set_state
+      
+      # Gets the current state of the toolbar item.
+      # 
+      # an or'd combination of flags from {Wx::AUI::AuiPaneButtonState} representing the current state
+      # @return [Integer]
+      def get_state; end
+      alias_method :state, :get_state
+      
+      # @param s [Wx::SizerItem] 
+      # @return [void]
+      def set_sizer_item(s) end
+      alias_method :sizer_item=, :set_sizer_item
+      
+      # @return [Wx::SizerItem]
+      def get_sizer_item; end
+      alias_method :sizer_item, :get_sizer_item
+      
+      # @param s [String] 
+      # @return [void]
+      def set_label(s) end
+      alias_method :label=, :set_label
+      
+      # @return [Wx::String]
+      def get_label; end
+      alias_method :label, :get_label
+      
+      # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      # @return [void]
+      def set_bitmap(bmp) end
+      alias_method :bitmap=, :set_bitmap
+      
+      # @return [Wx::Bitmap]
+      def get_bitmap; end
+      alias_method :bitmap, :get_bitmap
+      
+      # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      # @return [void]
+      def set_disabled_bitmap(bmp) end
+      alias_method :disabled_bitmap=, :set_disabled_bitmap
+      
+      # @return [Wx::Bitmap]
+      def get_disabled_bitmap; end
+      alias_method :disabled_bitmap, :get_disabled_bitmap
+      
+      # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+      # @return [void]
+      def set_hover_bitmap(bmp) end
+      alias_method :hover_bitmap=, :set_hover_bitmap
+      
+      # @return [Wx::Bitmap]
+      def get_hover_bitmap; end
+      alias_method :hover_bitmap, :get_hover_bitmap
+      
+      # @param s [String] 
+      # @return [void]
+      def set_short_help(s) end
+      alias_method :short_help=, :set_short_help
+      
+      # @return [Wx::String]
+      def get_short_help; end
+      alias_method :short_help, :get_short_help
+      
+      # @param s [String] 
+      # @return [void]
+      def set_long_help(s) end
+      alias_method :long_help=, :set_long_help
+      
+      # @return [Wx::String]
+      def get_long_help; end
+      alias_method :long_help, :get_long_help
+      
+      # @param s [Array(Integer, Integer), Wx::Size] 
+      # @return [void]
+      def set_min_size(s) end
+      alias_method :min_size=, :set_min_size
+      
+      # @return [Wx::Size]
+      def get_min_size; end
+      alias_method :min_size, :get_min_size
+      
+      # @param s [Integer] 
+      # @return [void]
+      def set_spacer_pixels(s) end
+      alias_method :spacer_pixels=, :set_spacer_pixels
+      
+      # @return [Integer]
+      def get_spacer_pixels; end
+      alias_method :spacer_pixels, :get_spacer_pixels
+      
+      # @param p [Integer] 
+      # @return [void]
+      def set_proportion(p) end
+      alias_method :proportion=, :set_proportion
+      
+      # @return [Integer]
+      def get_proportion; end
+      alias_method :proportion, :get_proportion
+      
+      # @param b [Boolean] 
+      # @return [void]
+      def set_active(b) end
+      alias_method :active=, :set_active
+      
+      # @return [Boolean]
+      def is_active; end
+      alias_method :active?, :is_active
+      
+      # Set whether this tool has a drop down button.
+      # 
+      # This is only valid for {Wx::ItemKind::ITEM_NORMAL} tools.
+      # @param b [Boolean] 
+      # @return [void]
+      def set_has_drop_down(b) end
+      alias_method :has_drop_down=, :set_has_drop_down
+      
+      # Returns whether the toolbar item has an associated drop down button.
+      # @return [Boolean]
+      def has_drop_down; end
+      alias_method :has_drop_down?, :has_drop_down
+      
+      # @param b [Boolean] 
+      # @return [void]
+      def set_sticky(b) end
+      alias_method :sticky=, :set_sticky
+      
+      # @return [Boolean]
+      def is_sticky; end
+      alias_method :sticky?, :is_sticky
+      
+      # Associates a number with the item.
+      # 
+      # 
+      # @see Wx::AUI::AuiToolBarItem#get_user_data 
+      # @param userData [Integer]  Number to associate
+      # @return [void]
+      def set_user_data(userData) end
+      alias_method :user_data=, :set_user_data
+      
+      # Get number associated with the item.
+      # 
+      # Associated number
+      # @see Wx::AUI::AuiToolBarItem#set_user_data 
+      # @return [Integer]
+      def get_user_data; end
+      alias_method :user_data, :get_user_data
+      
+      # Associates a {Wx::Object} with the item.
+      # 
+      # 
+      # @see Wx::AUI::AuiToolBarItem#get_client_data
+      # @param clientData [Wx::Object]  Pointer to the {Wx::Object}
+      # @return [void]
+      def set_client_data(clientData) end
+      alias_method :client_data=, :set_client_data
+      
+      # Get {Wx::Object} associated with the item.
+      # 
+      # Pointer to the associated {Wx::Object}
+      # @see Wx::AUI::AuiToolBarItem#set_client_data
+      # @return [Wx::Object]
+      def get_client_data; end
+      alias_method :client_data, :get_client_data
+      
+      # @param l [Integer] 
+      # @return [void]
+      def set_alignment(l) end
+      alias_method :alignment=, :set_alignment
+      
+      # @return [Integer]
+      def get_alignment; end
+      alias_method :alignment, :get_alignment
+      
+      # Returns whether the toolbar item can be toggled.
+      # @return [Boolean]
+      def can_be_toggled; end
+      alias_method :can_be_toggled?, :can_be_toggled
+      
+    end # AuiToolBarItem
+    
+
+  end
+
+end

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

@@ -0,0 +1,179 @@
+# ----------------------------------------------------------------------------
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# ----------------------------------------------------------------------------
+
+
+module Wx
+
+  class EvtHandler
+
+    # @!group AUI Event handler methods
+    
+    # Triggered when any button is pressed for any docked panes. 
+    # Processes a {Wx::AUI::EVT_AUI_PANE_BUTTON} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_pane_button(meth = nil, &block) end
+    
+    # Triggered when a docked or floating pane is closed. 
+    # Processes a {Wx::AUI::EVT_AUI_PANE_CLOSE} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_pane_close(meth = nil, &block) end
+    
+    # Triggered when a pane is minimized. This event is new since wxWidgets 3.3.2. 
+    # Processes a {Wx::AUI::EVT_AUI_PANE_MINIMIZE} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_pane_minimize(meth = nil, &block) end
+    
+    # Triggered when a pane is maximized. 
+    # Processes a {Wx::AUI::EVT_AUI_PANE_MAXIMIZE} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_pane_maximize(meth = nil, &block) end
+    
+    # Triggered when a pane is restored. 
+    # Processes a {Wx::AUI::EVT_AUI_PANE_RESTORE} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_pane_restore(meth = nil, &block) end
+    
+    # Triggered when a pane is made 'active'. This event is new since wxWidgets 2.9.4. 
+    # Processes a {Wx::AUI::EVT_AUI_PANE_ACTIVATED} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_pane_activated(meth = nil, &block) end
+    
+    # This event can be caught to override the default renderer in order to custom draw your {Wx::AUI::AuiManager} window (not recommended). 
+    # Processes a {Wx::AUI::EVT_AUI_RENDER} event.
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiManagerEvent] event the event to handle
+    def evt_aui_render(meth = nil, &block) end
+    
+    # A page is about to be closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSE} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_page_close(id, meth = nil, &block) end
+    
+    # A page has been closed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CLOSED} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_page_closed(winid, meth = nil, &block) end
+    
+    # The page selection was changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGED} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_page_changed(id, meth = nil, &block) end
+    
+    # The page selection is about to be changed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_page_changing(id, meth = nil, &block) end
+    
+    # The window list button has been pressed. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BUTTON} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_button(id, meth = nil, &block) end
+    
+    # Dragging is about to begin. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BEGIN_DRAG} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_begin_drag(id, meth = nil, &block) end
+    
+    # Dragging has ended. Processes a {Wx::AUI::EVT_AUINOTEBOOK_END_DRAG} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_end_drag(id, meth = nil, &block) end
+    
+    # Emitted during a drag and drop operation. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_MOTION} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_drag_motion(id, meth = nil, &block) end
+    
+    # Whether to allow a tab to be dropped. Processes a {Wx::AUI::EVT_AUINOTEBOOK_ALLOW_DND} event. This event must be specially allowed. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_allow_dnd(id, meth = nil, &block) end
+    
+    # Notify that the tab has been dragged. Processes a {Wx::AUI::EVT_AUINOTEBOOK_DRAG_DONE} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_drag_done(winid, meth = nil, &block) end
+    
+    # The middle mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_tab_middle_down(winid, meth = nil, &block) end
+    
+    # The middle mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_MIDDLE_UP} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_tab_middle_up(winid, meth = nil, &block) end
+    
+    # The right mouse button is pressed on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_DOWN} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_tab_right_down(winid, meth = nil, &block) end
+    
+    # The right mouse button is released on a tab. Processes a {Wx::AUI::EVT_AUINOTEBOOK_TAB_RIGHT_UP} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_tab_right_up(winid, meth = nil, &block) end
+    
+    # Double clicked on the tabs background area. Processes a {Wx::AUI::EVT_AUINOTEBOOK_BG_DCLICK} event. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] winid window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiNotebookEvent] event the event to handle
+    def evt_auinotebook_bg_dclick(winid, meth = nil, &block) end
+    
+    # Process a {Wx::AUI::EVT_AUITOOLBAR_TOOL_DROPDOWN} event 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiToolBarEvent] event the event to handle
+    def evt_auitoolbar_tool_dropdown(id, meth = nil, &block) end
+    
+    # Process a {Wx::AUI::EVT_AUITOOLBAR_OVERFLOW_CLICK} event 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiToolBarEvent] event the event to handle
+    def evt_auitoolbar_overflow_click(id, meth = nil, &block) end
+    
+    # Process a {Wx::AUI::EVT_AUITOOLBAR_RIGHT_CLICK} event 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiToolBarEvent] event the event to handle
+    def evt_auitoolbar_right_click(id, meth = nil, &block) end
+    
+    # Process a {Wx::AUI::EVT_AUITOOLBAR_MIDDLE_CLICK} event 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiToolBarEvent] event the event to handle
+    def evt_auitoolbar_middle_click(id, meth = nil, &block) end
+    
+    # Process a {Wx::AUI::EVT_AUITOOLBAR_BEGIN_DRAG} event 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::AUI::AuiToolBarEvent] event the event to handle
+    def evt_auitoolbar_begin_drag(id, meth = nil, &block) end
+    
+    # @!endgroup
+
+  end
+
+end

data/lib/wx/doc/gen/banner_window.rb

@@ -0,0 +1,124 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A simple banner window showing either a bitmap or text.
+  # 
+  # Banner windows can be used to present some overview of the current window contents to the user in an aesthetically pleasant way. They are typically positioned along the left or top edge of the window (although this class also supports right- and bottom-aligned banners) and show either a bitmap with a logo or a few lines of text on a gradient-filled background.
+  # Using this class is very simple, e.g.: 
+  # ```ruby
+  #   class MyFrame < Wx::Frame
+  # 
+  #     def initialize(...)
+  # 
+  #       # ... create the frame itself ...
+  # 
+  #       # Create and initialize the banner.
+  #       banner = Wx::BannerWindow.new(self, Wx::TOP)
+  #       banner.set_text("Welcome to my wonderful program",
+  #                       "  Before doing anything else, you need to connect to the online server.\n" +
+  #                       "  Please enter your credentials in the controls below.")
+  #  
+  #       # And position it along the top edge of the window.
+  #       sizer = Wx::VBoxSizer.new
+  #       sizer.add(banner, Wx::SizerFlags.new.expand)
+  #  
+  #       # ... add the rest of the window contents to the same sizer ...
+  #  
+  #       set_sizer_and_fit(sizer)
+  # 
+  #     end
+  # 
+  #     # ...
+  # 
+  #   end
+  # ```
+  # 
+  # This class is currently implemented generically and so looks the same under all platforms.
+  # 
+  # Category:  Miscellaneous Windows  <div class='appearance'><span class='appearance'>Appearance:</span><table class='appearance'><tr><td> Generic Appearance
+  #   </td></tr></table></div>
+  # 
+  # @wxrb_require USE_BANNERWINDOW
+  class BannerWindow < Window
+  
+    # @overload initialize()
+    #   Default constructor, use {Wx::BannerWindow#create} later.
+    #   
+    #   This constructor is only used for two-step creation, if possible, prefer using the constructor below directly instead of using this one and calling {Wx::BannerWindow#create} later.
+    #   @return [Wx::BannerWindow]
+    # @overload initialize(parent, winid, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BANNER_WINDOW_NAME_STR)
+    #   Full constructor provided for consistency with the other classes only.
+    #   
+    #   Prefer to use the shorter constructor documented above. You should rarely, if ever, need to use non-default values for any other parameters: as the banner window doesn't generate any events, its identifier is not particularly useful; its position and size will be almost always managed by the containing sizer and it doesn't have any specific styles. So only the parent and the banner direction need to be specified.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param dir [Wx::Direction] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::BannerWindow]
+    # @overload initialize(parent, winid, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BANNER_WINDOW_NAME_STR, &block)
+    #   Full constructor provided for consistency with the other classes only.
+    #   
+    #   Prefer to use the shorter constructor documented above. You should rarely, if ever, need to use non-default values for any other parameters: as the banner window doesn't generate any events, its identifier is not particularly useful; its position and size will be almost always managed by the containing sizer and it doesn't have any specific styles. So only the parent and the banner direction need to be specified.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param dir [Wx::Direction] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::BannerWindow] win new instance
+    #   @return [Wx::BannerWindow]
+    def initialize(*args) end
+    
+    # Really create the banner window for the objects created using the default constructor.
+    # 
+    # It's an error to call {Wx::BannerWindow#create} for the objects created using non-default constructor.
+    # @param parent [Wx::Window] 
+    # @param winid [Integer] 
+    # @param dir [Wx::Direction] 
+    # @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, dir=Wx::Direction::LEFT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::BANNER_WINDOW_NAME_STR) end
+    
+    # Provide the bitmap to use as background.
+    # 
+    # Notice that ideally the bitmap should be big enough to always cover the entire banner, e.g. for a horizontal banner with {Wx::Direction::TOP} style its width should be bigger than any reasonable window size. Otherwise the bitmap is extended to cover the entire window area with a solid colour taken from the bitmap pixel on the edge in which direction the extension occurs so all bitmap pixels on this edge (top for {Wx::Direction::LEFT}, right for {Wx::Direction::TOP} and {Wx::Direction::BOTTOM} and bottom for {Wx::Direction::RIGHT}) should have the same colour to avoid jarring discontinuity.
+    # If, on the other hand, the bitmap is bigger than the window size, then it is truncated. For {Wx::Direction::LEFT} orientation the bitmap is truncated from the top, for {Wx::Direction::TOP} and {Wx::Direction::BOTTOM}  from the right and for {Wx::Direction::RIGHT}  from the bottom, so put the most important part of the bitmap information in the opposite direction where it will never be truncated.
+    # If no valid background bitmap is specified, the banner draws gradient background but if a valid bitmap is given here, the gradient is not draw and the start and end colours specified for it are ignored.
+    # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap to use as background. May be invalid to indicate that no background bitmap should be used.
+    # @return [void]
+    def set_bitmap(bmp) end
+    alias_method :bitmap=, :set_bitmap
+    
+    # Set the text to display.
+    # 
+    # This is mutually exclusive with {Wx::BannerWindow#set_bitmap}.
+    # Title is rendered in bold and should be single line, message can have multiple lines but is not wrapped automatically, include explicit line breaks in the string if you want to have multiple lines.
+    # @param title [String] 
+    # @param message [String] 
+    # @return [void]
+    def set_text(title, message) end
+    
+    # Set the colours between which the gradient runs.
+    # 
+    # The gradient colours are ignored if {Wx::BannerWindow#set_bitmap} is used.
+    # @param start [Wx::Colour,String,Symbol] 
+    # @param end_ [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_gradient(start, end_) end
+    
+  end # BannerWindow
+  
+
+end