wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,278 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  NB_DEFAULT = 0
+  
+  # 
+  NB_TOP = 16
+  
+  # 
+  NB_BOTTOM = 32
+  
+  # 
+  NB_LEFT = 64
+  
+  # 
+  NB_RIGHT = 128
+  
+  # 
+  NB_FIXEDWIDTH = 256
+  
+  # 
+  NB_MULTILINE = 512
+  
+  # 
+  NB_NOPAGETHEME = 1024
+  
+  # 
+  # 
+  NB_HITTEST_NOWHERE = 1
+  
+  # 
+  # 
+  NB_HITTEST_ONICON = 2
+  
+  # 
+  # 
+  NB_HITTEST_ONLABEL = 4
+  
+  # 
+  # 
+  NB_HITTEST_ONITEM = 16
+  
+  # 
+  # 
+  NB_HITTEST_ONPAGE = 8
+  
+  # 
+  # 
+  EVT_NOTEBOOK_PAGE_CHANGED = 10200
+  
+  # 
+  # 
+  EVT_NOTEBOOK_PAGE_CHANGING = 10201
+  
+  # This class represents a notebook control, which manages multiple windows with associated tabs.
+  # 
+  # To use the class, create a {Wx::Notebook} object and call {Wx::Notebook::AddPage} or {Wx::Notebook#insert_page}, passing a window to be used as the page. Do not explicitly delete the window for a page that is currently managed by {Wx::Notebook}.
+  # <b>{Wx::NotebookPage}</b> is a typedef for {Wx::Window}.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::NB_TOP}: Place tabs on the top side. 
+  # 
+  # - {Wx::NB_LEFT}: Place tabs on the left side. 
+  # 
+  # - {Wx::NB_RIGHT}: Place tabs on the right side. 
+  # 
+  # - {Wx::NB_BOTTOM}: Place tabs under instead of above the notebook pages. 
+  # 
+  # - {Wx::NB_FIXEDWIDTH}: (Windows only) All tabs will have same width. 
+  # 
+  # - {Wx::NB_MULTILINE}: (Windows only) There can be several rows of tabs. 
+  # 
+  # - {Wx::NB_NOPAGETHEME}: (Windows only) Display a solid colour on notebook pages, and not a gradient, which can reduce performance. 
+  # 
+  # The styles {Wx::NB_LEFT}, RIGHT and BOTTOM are not supported under Microsoft Windows when using visual themes.
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_notebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_NOTEBOOK_PAGE_CHANGED} event. 
+  # 
+  # - {Wx::EvtHandler#evt_notebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_NOTEBOOK_PAGE_CHANGING} event. This event can be vetoed. 
+  # 
+  # ## Page backgrounds
+  # On Windows, the default theme paints a background on the notebook's pages. If you wish to suppress this theme, for aesthetic or performance reasons, there are three ways of doing it. You can use {Wx::NB_NOPAGETHEME} to disable themed drawing for a particular notebook, you can call {Wx::SystemOptions.set_option} to disable it for the whole application, or you can disable it for individual pages by using {Wx::Notebook#set_background_colour}.
+  # To disable themed pages globally: 
+  # ```ruby
+  #   Wx::SystemOptions.set_option("msw.notebook.themed-background", 0)
+  # ```
+  # 
+  # Set the value to 1 to enable it again. To give a single page a solid background that more or less fits in with the overall theme, use: 
+  # ```ruby
+  #   col = notebook.get_theme_background_colour
+  #   page.set_background_colour(col) if col.ok?
+  # ```
+  # 
+  # On platforms other than Windows, or if the application is not using Windows themes, {Wx::Notebook#get_theme_background_colour} will return an uninitialised colour object, and the above code will therefore work on all platforms.
+  # 
+  # Category:  Book Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # @see Wx::BookCtrl
+  # @see  Wx::BookCtrlEvent
+  # @see  Wx::ImageList
+  # @see  page_samples_notebook 
+  # 
+  # 
+  # @wxrb_require USE_NOTEBOOK
+  class Notebook < BookCtrlBase
+  
+    # @overload initialize()
+    #   Constructs a notebook control.
+    #   @return [Wx::Notebook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::NOTEBOOK_NAME_STR)
+    #   Constructs a notebook control.
+    #   
+    #   Note that sometimes you can reduce flicker by passing the {Wx::CLIP_CHILDREN} window style.
+    #   @param parent [Wx::Window]  The parent window. Must be non-null.
+    #   @param id [Integer]  The window identifier.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The window size.
+    #   @param style [Integer]  The window style. See {Wx::Notebook}.
+    #   @param name [String]  The name of the control.
+    #   @return [Wx::Notebook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::NOTEBOOK_NAME_STR, &block)
+    #   Constructs a notebook control.
+    #   
+    #   Note that sometimes you can reduce flicker by passing the {Wx::CLIP_CHILDREN} window style.
+    #   @param parent [Wx::Window]  The parent window. Must be non-null.
+    #   @param id [Integer]  The window identifier.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The window size.
+    #   @param style [Integer]  The window style. See {Wx::Notebook}.
+    #   @param name [String]  The name of the control.
+    #   @yieldparam [Wx::Notebook] win new instance
+    #   @return [Wx::Notebook]
+    def initialize(*args) end
+    
+    # Creates a notebook control.
+    # 
+    # See {Wx::Notebook#initialize} for a description of the parameters.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @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, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::NOTEBOOK_NAME_STR) end
+    
+    # Returns the number of rows in the notebook control.
+    # @return [Integer]
+    def get_row_count; end
+    alias_method :row_count, :get_row_count
+    
+    # If running under Windows and themes are enabled for the application, this function returns a suitable colour for painting the background of a notebook page, and can be passed to {Wx::Notebook#set_background_colour}.
+    # 
+    # Otherwise, an uninitialised colour will be returned.
+    # @return [Wx::Colour]
+    def get_theme_background_colour; end
+    alias_method :theme_background_colour, :get_theme_background_colour
+    
+    # Sets the amount of space around each page's icon and label, in pixels.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>The vertical padding cannot be changed in WXGTK. 
+    # </p>
+    # </div>
+    # @param padding [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def set_padding(padding) end
+    alias_method :padding=, :set_padding
+    
+    # This is a convenience function mapping {Wx::BK_TOP} etc styles to one of the {Wx::URLDataObject::Direction} enum elements.
+    # @return [Wx::Direction]
+    def get_tab_orientation; end
+    alias_method :tab_orientation, :get_tab_orientation
+    
+    # Return the rectangle of the given page tab in window coordinates.
+    # 
+    # This function always returns the rectangle for the specified tab, even if the tab is currently not visible.
+    # If page is invalid, an assert failure is triggered and an empty rectangle is returned.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Currently only available in Univ and MSW and always asserts in the other ports.
+    # </p>
+    # </div>
+    # @param page [Integer] 
+    # @return [Wx::Rect]
+    def get_tab_rect(page) end
+    alias_method :tab_rect, :get_tab_rect
+    
+    # Returns the image index for the given page.
+    # @param nPage [Integer] 
+    # @return [Integer]
+    def get_page_image(nPage) end
+    alias_method :page_image, :get_page_image
+    
+    # Sets the image index for the given page.
+    # 
+    # image is an index into the image list which was set with {Wx::Notebook#set_image_list}.
+    # @param page [Integer] 
+    # @param image [Integer] 
+    # @return [Boolean]
+    def set_page_image(page, image) end
+    
+    # Returns the string for the given page.
+    # @param nPage [Integer] 
+    # @return [String]
+    def get_page_text(nPage) end
+    alias_method :page_text, :get_page_text
+    
+    # Sets the text for the given page.
+    # 
+    # The text may contain mnemonics, i.e. accelerator characters preceded by the ampersand (<code>&</code>) character. If you need to include a literal ampersand in the text, you need to double it, i.e. use <code>&&</code>.
+    # @param page [Integer] 
+    # @param text [String] 
+    # @return [Boolean]
+    def set_page_text(page, text) end
+    
+    # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
+    # 
+    # Note that this method may return either the previously or newly selected page when called from the EVT_BOOKCTRL_PAGE_CHANGED handler depending on the platform and so {Wx::BookCtrlEvent#get_selection} should be used instead in this case.
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # 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::Notebook#change_selection} function if you don't want these events to be generated.
+    # @see Wx::Notebook#get_selection 
+    # @param page [Integer] 
+    # @return [Integer]
+    def set_selection(page) end
+    alias_method :selection=, :set_selection
+    
+    # Changes the selection to the given page, returning the previous selection.
+    # 
+    # This function behaves as {Wx::Notebook#set_selection} but does not generate the page changing events.
+    # See User Generated Events vs Programmatically Generated Events for more information.
+    # @param page [Integer] 
+    # @return [Integer]
+    def change_selection(page) end
+    
+    # Inserts a new page at the specified position.
+    # 
+    # true if successful, false otherwise.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Do not delete the page, it will be deleted by the book control.
+    # </p>
+    # </div>
+    # @see Wx::Notebook#add_page 
+    # @param index [Integer]  Specifies the position for the new page.
+    # @param page [Wx::Window]  Specifies the new page.
+    # @param text [String]  Specifies the text of the new page. Note that it may contain mnemonic characters, see {Wx::Notebook#set_page_text} for more information.
+    # @param select [Boolean]  Specifies whether the page should be selected.
+    # @param imageId [Integer]  Specifies the optional image index for the new page.
+    # @return [Boolean]
+    def insert_page(index, page, text, select=false, imageId=Wx::AUI::AuiNotebook::NO_IMAGE) end
+    
+  end # Notebook
+  
+
+end

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

@@ -0,0 +1,37 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Bit masks used for numeric validator styles.
+  # 
+  # A combination of these flags can be used when creating {Wx::IntegerValidator} and {Wx::FloatingPointValidator} objects and with their SetStyle() methods.
+  # 
+  # Category:  {Wx::Validators}
+  # 
+  # @wxrb_require USE_VALIDATORS
+  class NumValidatorStyle < Wx::Enum
+  
+    # Indicates absence of any other flags.
+    # 
+    NUM_VAL_DEFAULT = Wx::NumValidatorStyle.new(0)
+    
+    # Use thousands separators in the numbers.
+    # 
+    NUM_VAL_THOUSANDS_SEPARATOR = Wx::NumValidatorStyle.new(1)
+    
+    # Show a value of zero as an empty string.
+    # 
+    NUM_VAL_ZERO_AS_BLANK = Wx::NumValidatorStyle.new(2)
+    
+    # Remove trailing zeroes from the fractional part of the number.
+    # 
+    NUM_VAL_NO_TRAILING_ZEROES = Wx::NumValidatorStyle.new(4)
+    
+  end # NumValidatorStyle
+  
+
+end

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

@@ -0,0 +1,93 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Shows a dialog asking the user for numeric input.
+  # 
+  # The dialogs title is set to caption, it contains a (possibly) multiline message above the single line prompt and the zone for entering the number.
+  # The number entered must be in the range min to max (both of which should be positive) and value is the initial value of it. If the user enters an invalid value, it is forced to fall into the specified range. If the user cancels the dialog, the function returns -1. If it is important to distinguish between cancelling the dialog and actually entering -1 in it, i.e. if -1 is a valid input value, this convenience function can't be used and {Wx::NumberEntryDialog} should be used directly instead.
+  # Dialog is centered on its parent unless an explicit position is given in pos.
+  # @see Wx::NumberEntryDialog 
+  # @param message [String] 
+  # @param prompt [String] 
+  # @param caption [String] 
+  # @param value [Integer] 
+  # @param min [Integer] 
+  # @param max [Integer] 
+  # @param parent [Wx::Window] 
+  # @param pos [Array(Integer, Integer), Wx::Point] 
+  # @return [Integer]
+  def self.get_number_from_user(message, prompt, caption, value, min=0, max=100, parent=nil, pos=Wx::DEFAULT_POSITION) end
+  
+  # This class represents a dialog that requests a numeric input from the user.
+  # 
+  # Currently it is implemented as a generic wxWidgets dialog under all platforms.
+  # You can use a convenience {get_number_from_user} function instead of using this dialog.
+  # 
+  # Category:  Common Dialogs
+  # @see wxNumberEntryDialog Overview 
+  # 
+  # 
+  # @wxrb_require USE_NUMBERDLG
+  class NumberEntryDialog < Dialog
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   Call {Wx::NumberEntryDialog#create} to really create the dialog later.
+    #   @return [Wx::NumberEntryDialog]
+    # @overload initialize(parent, message, prompt, caption, value, min, max, pos=Wx::DEFAULT_POSITION)
+    #   Constructor.
+    #   
+    #   Use {Wx::NumberEntryDialog#show_modal} to show the dialog.
+    #   See {Wx::NumberEntryDialog#create} method for parameter description.
+    #   @param parent [Wx::Window] 
+    #   @param message [String] 
+    #   @param prompt [String] 
+    #   @param caption [String] 
+    #   @param value [Integer] 
+    #   @param min [Integer] 
+    #   @param max [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @return [Wx::NumberEntryDialog]
+    # @overload initialize(parent, message, prompt, caption, value, min, max, pos=Wx::DEFAULT_POSITION, &block)
+    #   Constructor.
+    #   
+    #   Use {Wx::NumberEntryDialog#show_modal} to show the dialog.
+    #   See {Wx::NumberEntryDialog#create} method for parameter description.
+    #   @param parent [Wx::Window] 
+    #   @param message [String] 
+    #   @param prompt [String] 
+    #   @param caption [String] 
+    #   @param value [Integer] 
+    #   @param min [Integer] 
+    #   @param max [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @yieldparam [Wx::NumberEntryDialog] win new instance
+    #   @return [Wx::NumberEntryDialog]
+    def initialize(*args) end
+    
+    # @param parent [Wx::Window]  Parent window.
+    # @param message [String]  Message to show on the dialog.
+    # @param prompt [String]  The prompt of the dialog.
+    # @param caption [String]  The caption of the dialog.
+    # @param value [Integer]  The default value.
+    # @param min [Integer]  The minimal value.
+    # @param max [Integer]  The maximal value.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
+    # @return [Boolean]
+    def create(parent, message, prompt, caption, value, min, max, pos=Wx::DEFAULT_POSITION) end
+    
+    # Returns the value that the user has entered if the user has pressed OK, or the original value if the user has pressed Cancel.
+    # @return [Integer]
+    def get_value; end
+    alias_method :value, :get_value
+    
+  end # NumberEntryDialog
+  
+
+end

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

@@ -0,0 +1,59 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Creates and returns an object of the given class, if the class has been registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
+  # @param className [String] 
+  # @return [Wx::Object]
+  def self.create_dynamic_object(className) end
+  
+  # This is the root class of many of the wxWidgets classes.
+  # 
+  # It declares a virtual destructor which ensures that destructors get called for all derived class objects where necessary.
+  # {Wx::Object} is the hub of a dynamic object creation scheme, enabling a program to create instances of a class only knowing its string class name, and to query the class hierarchy.
+  # The class contains optional debugging versions of <b>new</b> and <b>delete</b>, which can help trace memory allocation and deallocation problems.
+  # {Wx::Object} can be used to implement reference counted objects, such as {Wx::Pen}, {Wx::Bitmap} and others (see this list). See {Wx::RefCounter} and Reference Counting for more info about reference counting.
+  # 
+  # Category:  Runtime Type Information (RTTI)
+  # @see Wx::ClassInfo
+  # @see  Wx::Debugging
+  # @see  Reference Counting
+  # @see  wxObjectDataRef
+  # @see  Wx::ObjectDataPtr<T> 
+  # 
+  # 
+  class Object < ::Object
+  
+    # @overload initialize()
+    #   Default ctor; initializes to nil the internal reference data.
+    #   @return [Wx::Object]
+    # @overload initialize(other)
+    #   Copy ctor.
+    #   
+    #   Sets the internal {Wx::Object::m_refData} pointer to point to the same instance of the {Wx::ObjectRefData}-derived class pointed by other and increments the refcount of {Wx::Object::m_refData}.
+    #   @param other [Wx::Object] 
+    #   @return [Wx::Object]
+    def initialize(*args) end
+    
+    # Returns true if this object has the same data pointer as obj.
+    # 
+    # Notice that true is returned if the data pointers are nil in both objects.
+    # This function only does a shallow comparison, i.e. it doesn't compare the objects pointed to by the data pointers of these objects.
+    # @see Reference Counting 
+    # @param obj [Wx::Object] 
+    # @return [Boolean]
+    def is_same_as(obj) end
+    alias_method :same_as?, :is_same_as
+    
+    # This is the same of {Wx::Object#alloc_exclusive} but this method is public.
+    # @return [void]
+    def un_share; end
+    
+  end # Object
+  
+
+end