wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,330 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This function shows the standard about dialog containing the information specified in info.
+  # 
+  # If the current platform has a native about dialog which is capable of showing all the fields in info, the native dialog is used, otherwise the function falls back to the generic wxWidgets version of the dialog, i.e. does the same thing as {generic_about_box}.
+  # Here is an example of how this function may be used:
+  # ```ruby
+  #   def show_simple_about_dialog(event)
+  #     info = Wx::AboutDialogInfo.new
+  #     info.name = 'My Program'
+  #     info.version = '1.2.3 Beta'
+  #     info.description = 'This program does something great.'
+  #     info.copyright = '(C) 2007 Me <my@email.addre.ss>'
+  #        
+  #     Wx.about_box(info)
+  #   end
+  # ```
+  # 
+  # Please see the page_samples_dialogs for more examples of using this function and {Wx::AboutDialogInfo} for the description of the information which can be shown in the about dialog.
+  # @param info [Wx::AboutDialogInfo] 
+  # @param parent [Wx::Window] 
+  # @return [void]
+  def self.about_box(info, parent=nil) end
+  
+  # {Wx::AboutDialogInfo} contains information shown in the standard About dialog displayed by the {about_box} function.
+  # 
+  # This class contains the general information about the program, such as its name, version, copyright and so on, as well as lists of the program developers, documentation writers, artists and translators. The simple properties from the former group are represented as a string with the exception of the program icon and the program web site, while the lists from the latter group are stored as {Wx::ArrayString} and can be either set entirely at once using {Wx::AboutDialogInfo#set_developers} and similar functions or built one by one using {Wx::AboutDialogInfo#add_developer} etc.
+  # Please also notice that while all the main platforms have the native implementation of the about dialog, they are often more limited than the generic version provided by wxWidgets and so the generic version is used if {Wx::AboutDialogInfo} has any fields not supported by the native version. Currently GTK+ version supports all the possible fields natively but MSW and Mac versions don't support URLs, licence text nor custom icons in the about dialog and if either of those is used, {about_box} will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel.
+  # 
+  # Example of usage:
+  # 
+  # ```ruby
+  #   def on_about(event)
+  #     info = Wx::AboutDialogInfo.new
+  #     info.name = 'MyApp'
+  #     info.version = MY_APP_VERSION_STRING
+  #     info.description = 'My wxWidgets-based application!'
+  #     info.copyright = '(C) 1992-2023'
+  #     info.add_developer('My Self')
+  #        
+  #     Wx.about_box(info)
+  #   end
+  # ```
+  # 
+  # Category:  Common Dialogs, Data Structures
+  # @see Wx::AboutDialogInfo#set_artists 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_ABOUTDLG
+  class AboutDialogInfo < ::Object
+  
+    # Default constructor leaves all fields are initially uninitialized, in general you should call at least {Wx::AboutDialogInfo#set_version}, {Wx::AboutDialogInfo#set_copyright} and {Wx::AboutDialogInfo#set_description}.
+    # @return [Wx::AboutDialogInfo]
+    def initialize; end
+    
+    # Adds an artist name to be shown in the program credits.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#set_artists 
+    # @param artist [String] 
+    # @return [void]
+    def add_artist(artist) end
+    
+    # Adds a developer name to be shown in the program credits.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#set_developers 
+    # @param developer [String] 
+    # @return [void]
+    def add_developer(developer) end
+    
+    # Adds a documentation writer name to be shown in the program credits.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#set_doc_writers 
+    # @param docwriter [String] 
+    # @return [void]
+    def add_doc_writer(docwriter) end
+    
+    # Adds a translator name to be shown in the program credits.
+    # 
+    # Notice that if no translator names are specified explicitly, {about_box} will try to use the translation of the string <code>translator-credits</code> from the currently used message catalog  this can be used to show just the name of the translator of the program in the current language.
+    # @see Wx::AboutDialogInfo#set_translators 
+    # @param translator [String] 
+    # @return [void]
+    def add_translator(translator) end
+    
+    # Get the name of the program.
+    # 
+    # Name of the program
+    # @see Wx::AboutDialogInfo#set_name 
+    # @return [String]
+    def get_name; end
+    alias_method :name, :get_name
+    
+    # Returns true if a description string has been specified.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#get_description 
+    # @return [Boolean]
+    def has_description; end
+    alias_method :has_description?, :has_description
+    
+    # Get the description string.
+    # 
+    # The description string, free-form.
+    # @return [Wx::String]
+    def get_description; end
+    alias_method :description, :get_description
+    
+    # Returns true if a copyright string has been specified.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#get_copyright 
+    # @return [Boolean]
+    def has_copyright; end
+    alias_method :has_copyright?, :has_copyright
+    
+    # Get the copyright string.
+    # 
+    # The copyright string
+    # @return [Wx::String]
+    def get_copyright; end
+    alias_method :copyright, :get_copyright
+    
+    # Sets the list of artists to be shown in the program credits.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#add_artist 
+    # @param artists [Array<String>] 
+    # @return [void]
+    def set_artists(artists) end
+    alias_method :artists=, :set_artists
+    
+    # Set the short string containing the program copyright information.
+    # 
+    # Notice that any occurrences of <code>"(C)"</code> in copyright will be replaced by the copyright symbol (circled C) automatically, which means that you can avoid using this symbol in the program source code which can be problematic,
+    # Also note that under MSW platform the word "Copyright" itself will be removed from the string if it is followed by the copyright symbol, to follow the platform convention.
+    # @param copyright [String] 
+    # @return [void]
+    def set_copyright(copyright) end
+    alias_method :copyright=, :set_copyright
+    
+    # Set brief, but possibly multiline, description of the program.
+    # @param desc [String] 
+    # @return [void]
+    def set_description(desc) end
+    alias_method :description=, :set_description
+    
+    # Set the list of developers of the program.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#add_developer 
+    # @param developers [Array<String>] 
+    # @return [void]
+    def set_developers(developers) end
+    alias_method :developers=, :set_developers
+    
+    # Set the list of documentation writers.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#add_doc_writer 
+    # @param docwriters [Array<String>] 
+    # @return [void]
+    def set_doc_writers(docwriters) end
+    alias_method :doc_writers=, :set_doc_writers
+    
+    # Returns true if an icon has been set for the about dialog.
+    # @return [Boolean]
+    def has_icon; end
+    alias_method :has_icon?, :has_icon
+    
+    # Returns the icon set by {Wx::AboutDialogInfo#set_icon}.
+    # @return [Wx::Icon]
+    def get_icon; end
+    alias_method :icon, :get_icon
+    
+    # Set the icon to be shown in the dialog.
+    # 
+    # By default the icon of the main frame will be shown if the native about dialog supports custom icons. If it doesn't but a valid icon is specified using this method, the generic about dialog is used instead so you should avoid calling this function for maximally native look and feel.
+    # @param icon [Wx::Icon] 
+    # @return [void]
+    def set_icon(icon) end
+    alias_method :icon=, :set_icon
+    
+    # Returns true if the licence string has been set.
+    # @return [Boolean]
+    def has_licence; end
+    alias_method :has_licence?, :has_licence
+    
+    # Returns the licence string.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#set_licence 
+    # @return [Wx::String]
+    def get_licence; end
+    alias_method :licence, :get_licence
+    
+    # Set the long, multiline string containing the text of the program licence.
+    # 
+    # Only GTK+ version supports showing the licence text in the native about dialog currently so the generic version will be used under all the other platforms if this method is called. To preserve the native look and feel it is advised that you do not call this method but provide a separate menu item in the <code>"Help"</code> menu for displaying the text of your program licence.
+    # @param licence [String] 
+    # @return [void]
+    def set_licence(licence) end
+    alias_method :licence=, :set_licence
+    
+    # This is the same as {Wx::AboutDialogInfo#set_licence}.
+    # @param licence [String] 
+    # @return [void]
+    def set_license(licence) end
+    alias_method :license=, :set_license
+    
+    # Set the name of the program.
+    # 
+    # If this method is not called, the string returned by {Wx::App::GetAppName} will be shown in the dialog.
+    # @param name [String] 
+    # @return [void]
+    def set_name(name) end
+    alias_method :name=, :set_name
+    
+    # Set the list of translators.
+    # 
+    # Please see {Wx::AboutDialogInfo#add_translator} for additional discussion.
+    # @param translators [Array<String>] 
+    # @return [void]
+    def set_translators(translators) end
+    alias_method :translators=, :set_translators
+    
+    # Set the version of the program.
+    # 
+    # The word "version" shouldn't be included in version. Example version values: "1.2" and "RC2". In about dialogs with more space set aside for version information, longVersion is used. Example longVersion values: "Version 1.2" and "Release Candidate 2". If version is non-empty but longVersion is empty, a long version is constructed automatically, using version (by simply prepending "Version " to version).
+    # The generic about dialog and native GTK+ dialog use version only, as a suffix to the program name. The native MSW and macOS about dialogs use the long version.
+    # @param version [String] 
+    # @param longVersion [String] 
+    # @return [void]
+    def set_version(version, longVersion=('')) end
+    alias_method :version=, :set_version
+    
+    # Return the short version string.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#set_version 
+    # @return [Wx::String]
+    def get_version; end
+    alias_method :version, :get_version
+    
+    # Return the long version string if set.
+    # 
+    # 
+    # @see Wx::AboutDialogInfo#set_version 
+    # @return [Wx::String]
+    def get_long_version; end
+    alias_method :long_version, :get_long_version
+    
+    # Returns true if the website info has been set.
+    # @return [Boolean]
+    def has_web_site; end
+    alias_method :has_web_site?, :has_web_site
+    
+    # Returns the website URL set for the dialog.
+    # @return [Wx::String]
+    def get_web_site_url; end
+    alias_method :web_site_url, :get_web_site_url
+    
+    # Returns the description of the website URL set for the dialog.
+    # @return [Wx::String]
+    def get_web_site_description; end
+    alias_method :web_site_description, :get_web_site_description
+    
+    # Set the web site for the program and its description (which defaults to url itself if empty).
+    # 
+    # Please notice that only GTK+ version currently supports showing the link in the native about dialog so if this method is called, the generic version will be used under all the other platforms.
+    # @param url [String] 
+    # @param desc [String] 
+    # @return [void]
+    def set_web_site(url, desc=('')) end
+    alias_method :web_site=, :set_web_site
+    
+    # Returns true if developers have been set in the dialog info.
+    # @return [Boolean]
+    def has_developers; end
+    alias_method :has_developers?, :has_developers
+    
+    # Returns an array of the developer strings set in the dialog info.
+    # @return [Wx::ArrayString]
+    def get_developers; end
+    alias_method :developers, :get_developers
+    
+    # Returns true if writers have been set in the dialog info.
+    # @return [Boolean]
+    def has_doc_writers; end
+    alias_method :has_doc_writers?, :has_doc_writers
+    
+    # Returns an array of the writer strings set in the dialog info.
+    # @return [Wx::ArrayString]
+    def get_doc_writers; end
+    alias_method :doc_writers, :get_doc_writers
+    
+    # Returns true if artists have been set in the dialog info.
+    # @return [Boolean]
+    def has_artists; end
+    alias_method :has_artists?, :has_artists
+    
+    # Returns an array of the artist strings set in the dialog info.
+    # @return [Wx::ArrayString]
+    def get_artists; end
+    alias_method :artists, :get_artists
+    
+    # Returns true if translators have been set in the dialog info.
+    # @return [Boolean]
+    def has_translators; end
+    alias_method :has_translators?, :has_translators
+    
+    # Returns an array of the translator strings set in the dialog info.
+    # @return [Wx::ArrayString]
+    def get_translators; end
+    alias_method :translators, :get_translators
+    
+  end # AboutDialogInfo
+  
+
+end

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

@@ -0,0 +1,178 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::AcceleratorEntry} flags
+  # 
+  # 
+  # 
+  # @wxrb_require USE_ACCEL
+  class AcceleratorEntryFlags < Wx::Enum
+  
+    # no modifiers
+    # 
+    ACCEL_NORMAL = Wx::AcceleratorEntryFlags.new(0)
+    
+    # hold Alt key down
+    # 
+    ACCEL_ALT = Wx::AcceleratorEntryFlags.new(1)
+    
+    # hold Ctrl key down, corresponds to Command key on macOS
+    # 
+    ACCEL_CTRL = Wx::AcceleratorEntryFlags.new(2)
+    
+    # hold Shift key down
+    # 
+    ACCEL_SHIFT = Wx::AcceleratorEntryFlags.new(4)
+    
+    # corresponds to real Ctrl key on macOS, identic to {Wx::AcceleratorEntryFlags::ACCEL_CTRL} on other platforms
+    # 
+    ACCEL_RAW_CTRL = Wx::AcceleratorEntryFlags.new(2)
+    
+    # deprecated, identic to {Wx::AcceleratorEntryFlags::ACCEL_CTRL} on all platforms.
+    # 
+    ACCEL_CMD = Wx::AcceleratorEntryFlags.new(2)
+    
+  end # AcceleratorEntryFlags
+  
+  # An empty accelerator table.
+  # 
+  NULL_ACCELERATOR_TABLE = nil
+  
+  # An object used by an application wishing to create an accelerator table (see {Wx::AcceleratorTable}).
+  # 
+  # Category:  Data Structures
+  # @see Wx::AcceleratorTable
+  # @see  Wx::Window#set_accelerator_table 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_ACCEL
+  class AcceleratorEntry < ::Object
+  
+    # @overload initialize(flags=0, keyCode=0, cmd=0, item=nil)
+    #   Constructor.
+    #   @param flags [Integer]  A combination of the {Wx::AcceleratorEntryFlags} values, which indicates which modifier keys are held down.
+    #   @param keyCode [Integer,String]  The keycode (or character) to be detected. See {Wx::KeyCode} for a full list of keycodes.
+    #   @param cmd [Integer]  The menu or control command identifier (ID).
+    #   @param item [Wx::MenuItem]  The menu item associated with this accelerator.
+    #   @return [Wx::AcceleratorEntry]
+    # @overload initialize(entry)
+    #   Copy ctor.
+    #   @param entry [Wx::AcceleratorEntry] 
+    #   @return [Wx::AcceleratorEntry]
+    def initialize(*args) end
+    
+    # Returns the command identifier for the accelerator table entry.
+    # @return [Integer]
+    def get_command; end
+    alias_method :command, :get_command
+    
+    # Returns the flags for the accelerator table entry.
+    # @return [Integer]
+    def get_flags; end
+    alias_method :flags, :get_flags
+    
+    # Returns the keycode for the accelerator table entry.
+    # @return [Integer]
+    def get_key_code; end
+    alias_method :key_code, :get_key_code
+    
+    # Returns the menu item associated with this accelerator entry.
+    # @return [Wx::MenuItem]
+    def get_menu_item; end
+    alias_method :menu_item, :get_menu_item
+    
+    # Sets the accelerator entry parameters.
+    # @param flags [Integer]  A combination of the {Wx::AcceleratorEntryFlags} values, which indicates which modifier keys are held down.
+    # @param keyCode [Integer,String]  The keycode to be detected. See {Wx::KeyCode} for a full list of keycodes.
+    # @param cmd [Integer]  The menu or control command identifier (ID).
+    # @param item [Wx::MenuItem]  The menu item associated with this accelerator.
+    # @return [void]
+    def set(flags, keyCode, cmd, item=nil) end
+    
+    # Returns true if this object is correctly initialized.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns a textual representation of this accelerator.
+    # 
+    # The returned string is of the form <code>[Alt+][Ctrl+][RawCtrl+][Shift+]Key</code> where the modifier keys are present only if the corresponding flag is set.
+    # @return [String]
+    def to_string; end
+    
+    # Returns a textual representation of this accelerator which is appropriate for saving in configuration files.
+    # 
+    # Unlike the string returned by {Wx::AcceleratorEntry#to_string}, this one is never translated so, while it's not suitable for showing to the user, it can be used to uniquely identify the accelerator independently of the user language.
+    # The returned string can still be parsed by {Wx::AcceleratorEntry#from_string}.
+    # @return [String]
+    def to_raw_string; end
+    
+    # Parses the given string and sets the accelerator accordingly.
+    # 
+    # true if the given string correctly initialized this object (i.e. if {Wx::AcceleratorEntry#is_ok} returns true after this call)
+    # @param str [String]  This string may be either in the same format as returned by {Wx::AcceleratorEntry#to_string}, i.e. contain the accelerator itself only, or have the format of a full menu item text with i.e. <code>Label TAB Accelerator</code>. In the latter case, the part of the string before the TAB is ignored. Notice that the latter format is only supported for the compatibility with the previous wxWidgets versions and the new code should pass only the accelerator string itself to this function.
+    # @return [Boolean]
+    def from_string(str) end
+    
+    # @param entry [Wx::AcceleratorEntry] 
+    # @return [Boolean]
+    def ==(entry) end
+    
+  end # AcceleratorEntry
+  
+  # An accelerator table allows the application to specify a table of keyboard shortcuts for menu or button commands.
+  # 
+  # The object {Wx::NULL_ACCELERATOR_TABLE} is defined to be a table with no data, and is the initial accelerator table for a window.
+  # Example:
+  # ```ruby
+  #   entries = [
+  #       Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'N', ID_NEW_WINDOW),
+  #       Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'X', Wx::ID_EXIT),
+  #       Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'A', Wx::ID_ABOUT),
+  #       Wx::AcceleratorEntry.new(Wx::ACCEL_CTRL, 'N', Wx::ID_CUT)
+  #     ]
+  #   frame.accelerator_table = Wx::AcceleratorTable[entries]
+  # ```
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>An accelerator takes precedence over normal processing and can be a convenient way to program some event handling. For example, you can use an accelerator table to enable a dialog with a multi-line text control to accept CTRL-Enter as meaning 'OK'.
+  # </p>
+  # </div>
+  # 
+  # Category:  Data Structures
+  # Predefined objects/pointers: {Wx::NULL_ACCELERATOR_TABLE}
+  # @see Wx::AcceleratorEntry
+  # @see  Wx::Window#set_accelerator_table 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_ACCEL
+  class AcceleratorTable < Object
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::AcceleratorTable]
+    # @overload initialize(entries)
+    #   Initializes the accelerator table from an array of {Wx::AcceleratorEntry}.
+    #   @param entries [Array<Wx::AcceleratorEntry>]  The array of entries.
+    #   @return [Wx::AcceleratorTable]
+    def initialize(*args) end
+    
+    # Returns true if the accelerator table is valid.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+  end # AcceleratorTable
+  
+
+end

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

@@ -0,0 +1,83 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Small control showing an animation indicating that the program is currently busy performing some background task.
+  # 
+  # Category:  {Wx::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>
+  # 
+  # @wxrb_require USE_ACTIVITYINDICATOR
+  class ActivityIndicator < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   Use {Wx::ActivityIndicator#create} to really create the control after using this constructor.
+    #   @return [Wx::ActivityIndicator]
+    # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("ACTIVITYINDICATOR"))
+    #   Constructor fully creating the control.
+    #   
+    #   The arguments have the usual meanings and only parent is typically required.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::ActivityIndicator]
+    # @overload initialize(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("ACTIVITYINDICATOR"), &block)
+    #   Constructor fully creating the control.
+    #   
+    #   The arguments have the usual meanings and only parent is typically required.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::ActivityIndicator] win new instance
+    #   @return [Wx::ActivityIndicator]
+    def initialize(*args) end
+    
+    # Create the control initialized using the default constructor.
+    # 
+    # This method can be used to finish the control creation if it hadn't been done already by using the non-default constructor.
+    # @param parent [Wx::Window] 
+    # @param winid [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, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=("ACTIVITYINDICATOR")) end
+    
+    # Starts animation of the indicator.
+    # 
+    # Does nothing if the indicator is already running.
+    # @return [void]
+    def start; end
+    
+    # Stops the animation of the indicator.
+    # 
+    # Notice that the animation is stopped even if {Wx::ActivityIndicator#start} had been called multiple times before, i.e. the calls are not cumulative.
+    # @return [void]
+    def stop; end
+    
+    # Returns true if the control is currently showing activity.
+    # 
+    # Returns false initially, true once {Wx::ActivityIndicator#start} is called and false again after calling {Wx::ActivityIndicator#stop}.
+    # @return [Boolean]
+    def is_running; end
+    alias_method :running?, :is_running
+    
+  end # ActivityIndicator
+  
+
+end