wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,31 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class allows platforms to implement functionality to optimise GDI objects, such as {Wx::Pen}, {Wx::Brush} and {Wx::Font}.
+  # 
+  # On Windows, the underling GDI objects are a scarce resource and are cleaned up when a usage count goes to zero. On some platforms this class may not have any special functionality.
+  # Since the functionality of this class is platform-specific, it is not documented here in detail.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # @see Wx::Pen
+  # @see  Wx::Brush
+  # @see  Wx::Font 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class GDIObject < Object
+  
+    # Default constructor.
+    # @return [Wx::GDIObject]
+    def initialize; end
+    
+  end # GDIObject
+  
+
+end

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

@@ -0,0 +1,140 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Show generic about dialog.
+  # 
+  # This function does the same thing as {about_box} except that it always uses the generic wxWidgets version of the dialog instead of the native one.
+  # @param info [Wx::AboutDialogInfo] 
+  # @param parent [Wx::Window] 
+  # @return [void]
+  def self.generic_about_box(info, parent=nil) end
+  
+  # This class defines a customizable About dialog.
+  # 
+  # Note that if you don't need customization, you should use the global {about_box} function that is both easier to use and shows the native dialog if available.
+  # To use this class, you need to derive your own class from it and override the virtual method {Wx::GenericAboutDialog#do_add_custom_controls}.
+  # To instantiate an object from your {Wx::GenericAboutDialog}-based class, you can use either the default constructor followed by a call to {Wx::GenericAboutDialog#create}, or directly using the alternate constructor. In either case, you have to prepare a {Wx::AboutDialogInfo} containing standard information to display in an about-box.
+  # Example of usage, MyAboutDlg being a class derived from {Wx::GenericAboutDialog}: 
+  # ```ruby
+  # class MyFrame < Wx::Frame
+  # 
+  #   # declare custom about dialog class                        
+  #   class MyAboutDlg < Wx::GenericAboutDialog
+  # 
+  #     def initialize(about_info, parent=nil)
+  #       super()
+  # 
+  #       create(about_info, parent)
+  #     end
+  # 
+  #     def do_add_custom_controls
+  #       # add custom controls ...
+  #     end
+  #     protected :do_add_custom_controls
+  # 
+  #   end
+  # 
+  #   # fill in MyFrame class ...
+  # 
+  #   # handler for an About menu/button
+  #   def on_about(_evt)
+  #     aboutInfo = Wx::AboutDialogInfo.new
+  #     
+  #     aboutInfo.set_name('MyApp')
+  #     aboutInfo.set_version(MY_APP_VERSION_STRING)
+  #     aboutInfo.set_description('My wxWidgets-based application!')
+  #     aboutInfo.set_copyright('(C) 1992-2024')
+  #     aboutInfo.set_web_site('http://myapp.org')
+  #     aboutInfo.add_developer('My Self')
+  #     
+  #     MyFrame.MyAboutDlg(aboutInfo, self) do |dlgAbout|
+  #       dlgAbout.show_modal
+  #     end
+  #   end
+  # end
+  # ```
+  # 
+  # Category:  Common Dialogs
+  # @see Wx::AboutDialogInfo 
+  # 
+  # 
+  # @wxrb_require USE_ABOUTDLG
+  class GenericAboutDialog < Dialog
+  
+    # @overload initialize()
+    #   Default constructor, {Wx::GenericAboutDialog#create} must be called later.
+    #   @return [Wx::GenericAboutDialog]
+    # @overload initialize(info, parent=nil)
+    #   Creates the dialog and initializes it with the given information.
+    #   @param info [Wx::AboutDialogInfo] 
+    #   @param parent [Wx::Window] 
+    #   @return [Wx::GenericAboutDialog]
+    # @overload initialize(info, parent=nil, &block)
+    #   Creates the dialog and initializes it with the given information.
+    #   @param info [Wx::AboutDialogInfo] 
+    #   @param parent [Wx::Window] 
+    #   @yieldparam [Wx::GenericAboutDialog] win new instance
+    #   @return [Wx::GenericAboutDialog]
+    def initialize(*args) end
+    
+    # Initializes the dialog created using the default constructor.
+    # @param info [Wx::AboutDialogInfo] 
+    # @param parent [Wx::Window] 
+    # @return [Boolean]
+    def create(info, parent=nil) end
+    
+    # @overload add_control(win, flags)
+    #   Add arbitrary control to the sizer content with the specified flags.
+    #   
+    #   For example, here is how to add an expandable line with a border of 3 pixels, then a line of text: 
+    #   ```
+    #     AddControl(new wxStaticLine(this), wxSizerFlags().Expand().Border(wxALL, 3));
+    #     
+    #     AddText(_("This line is just an example of custom text."));
+    #   ```
+    #   @param win [Wx::Window] 
+    #   @param flags [Wx::SizerFlags] 
+    #   @return [void]
+    # @overload add_control(win)
+    #   Add arbitrary control to the sizer content and centre it.
+    #   @param win [Wx::Window] 
+    #   @return [void]
+    def add_control(*args) end
+    
+    # Add the given (not empty) text to the sizer content.
+    # @param text [String] 
+    # @return [void]
+    def add_text(text) end
+    
+    # Add a {Wx::CollapsiblePane} containing the given text.
+    # @param title [String] 
+    # @param text [String] 
+    # @return [void]
+    def add_collapsible_pane(title, text) end
+    
+    # Return the parent to use for custom controls.
+    # 
+    # See {Wx::GenericAboutDialog#do_add_custom_controls}.
+    # @return [Wx::Window]
+    def get_custom_control_parent; end
+    alias_method :custom_control_parent, :get_custom_control_parent
+    
+    
+    protected
+    
+    # This virtual method may be overridden to add more controls to the dialog.
+    # 
+    # The custom controls should be created with {Wx::GenericAboutDialog#get_custom_control_parent} as parent and then can be passed to the protected {Wx::GenericAboutDialog#add_control} method. {Wx::GenericAboutDialog#add_text} and {Wx::GenericAboutDialog#add_collapsible_pane} methods can also be used to add simple static custom controls.
+    # This method is called during the dialog creation and you don't need to call it, only to override it.
+    # @return [void]
+    def do_add_custom_controls; end
+    
+  end # GenericAboutDialog
+  
+
+end

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

@@ -0,0 +1,223 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This control can be used to place a directory listing (with optional files) on an arbitrary window.
+  # 
+  # The control contains a {Wx::TreeCtrl} window representing the directory hierarchy, and optionally, a {Wx::Choice} window containing a list of filters.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::DIRCTRL_DIR_ONLY}: Only show directories, and not files. 
+  # 
+  # - {Wx::DIRCTRL_3D_INTERNAL}: Use 3D borders for internal controls. This is the default. 
+  # 
+  # - {Wx::DIRCTRL_SELECT_FIRST}: When setting the default path, select the first file in the directory. 
+  # 
+  # - {Wx::DIRCTRL_SHOW_FILTERS}: Show the drop-down filter list. 
+  # 
+  # - {Wx::DIRCTRL_EDIT_LABELS}: Allow the folder and file labels to be editable. 
+  # 
+  # - {Wx::DIRCTRL_MULTIPLE}: Allows multiple files and folders to be selected. 
+  # 
+  # 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>
+  # ### Events emitted by this class
+  # 
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_dirctrl_selectionchanged}(id, meth = nil, &block): Selected directory has changed. Processes a {Wx::EVT_DIRCTRL_SELECTIONCHANGED} event type. Notice that this event is generated even for the changes done by the program itself and not only those done by the user. Available since wxWidgets 2.9.5. 
+  # 
+  # - {Wx::EvtHandler#evt_dirctrl_fileactivated}(id, meth = nil, &block): The user activated a file by double-clicking or pressing Enter. Available since wxWidgets 2.9.5.
+  # 
+  # @wxrb_require USE_DIRDLG|USE_FILEDLG
+  class GenericDirCtrl < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::GenericDirCtrl]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, dir=Wx::DIR_DIALOG_DEFAULT_FOLDER_STR, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DIRCTRL_DEFAULT_STYLE, filter=(''), defaultFilter=0, name=Wx::TREE_CTRL_NAME_STR)
+    #   Main constructor.
+    #   @param parent [Wx::Window]  Parent window.
+    #   @param id [Integer]  Window identifier.
+    #   @param dir [String]  Initial folder.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Size.
+    #   @param style [Integer]  Window style. Please see {Wx::GenericDirCtrl} for a list of possible styles.
+    #   @param filter [String]  A filter string, using the same syntax as that for {Wx::FileDialog}. This may be empty if filters are not being used. Example: <code>"All files (<em>.</em>)|*.*|JPEG files (<em>.jpg)|</em>.jpg"</code>
+    #   @param defaultFilter [Integer]  The zero-indexed default filter setting.
+    #   @param name [String]  The window name.
+    #   @return [Wx::GenericDirCtrl]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, dir=Wx::DIR_DIALOG_DEFAULT_FOLDER_STR, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DIRCTRL_DEFAULT_STYLE, filter=(''), defaultFilter=0, name=Wx::TREE_CTRL_NAME_STR, &block)
+    #   Main constructor.
+    #   @param parent [Wx::Window]  Parent window.
+    #   @param id [Integer]  Window identifier.
+    #   @param dir [String]  Initial folder.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Size.
+    #   @param style [Integer]  Window style. Please see {Wx::GenericDirCtrl} for a list of possible styles.
+    #   @param filter [String]  A filter string, using the same syntax as that for {Wx::FileDialog}. This may be empty if filters are not being used. Example: <code>"All files (<em>.</em>)|*.*|JPEG files (<em>.jpg)|</em>.jpg"</code>
+    #   @param defaultFilter [Integer]  The zero-indexed default filter setting.
+    #   @param name [String]  The window name.
+    #   @yieldparam [Wx::GenericDirCtrl] win new instance
+    #   @return [Wx::GenericDirCtrl]
+    def initialize(*args) end
+    
+    # Collapse the given path.
+    # @param path [String] 
+    # @return [Boolean]
+    def collapse_path(path) end
+    
+    # Collapses the entire tree.
+    # @return [void]
+    def collapse_tree; end
+    
+    # Create function for two-step construction.
+    # 
+    # See {Wx::GenericDirCtrl#initialize} for details.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param dir [String] 
+    # @param pos [Array(Integer, Integer), Wx::Point] 
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @param style [Integer] 
+    # @param filter [String] 
+    # @param defaultFilter [Integer] 
+    # @param name [String] 
+    # @return [Boolean]
+    def create(parent, id=Wx::StandardID::ID_ANY, dir=Wx::DIR_DIALOG_DEFAULT_FOLDER_STR, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DIRCTRL_DEFAULT_STYLE, filter=(''), defaultFilter=0, name=Wx::TREE_CTRL_NAME_STR) end
+    
+    # Tries to expand as much of the given path as possible, so that the filename or directory is visible in the tree control.
+    # @param path [String] 
+    # @return [Boolean]
+    def expand_path(path) end
+    
+    # Gets the default path.
+    # @return [String]
+    def get_default_path; end
+    alias_method :default_path, :get_default_path
+    
+    # Gets selected filename path only (else empty string).
+    # 
+    # This function doesn't count a directory as a selection.
+    # @return [String]
+    def get_file_path; end
+    alias_method :file_path, :get_file_path
+    
+    # Fills the array paths with the currently selected filepaths.
+    # 
+    # This function doesn't count a directory as a selection.
+    # @param paths [Array<String>] 
+    # @return [void]
+    def get_file_paths(paths) end
+    alias_method :file_paths, :get_file_paths
+    
+    # Returns the filter string.
+    # @return [String]
+    def get_filter; end
+    alias_method :filter, :get_filter
+    
+    # Returns the current filter index (zero-based).
+    # @return [Integer]
+    def get_filter_index; end
+    alias_method :filter_index, :get_filter_index
+    
+    # Returns a pointer to the filter list control (if present).
+    # @return [Wx::DirFilterListCtrl]
+    def get_filter_list_ctrl; end
+    alias_method :filter_list_ctrl, :get_filter_list_ctrl
+    
+    # @overload get_path()
+    #   Gets the currently-selected directory or filename.
+    #   @return [String]
+    # @overload get_path(itemId)
+    #   Gets the path corresponding to the given tree control item.
+    #   @param itemId [Wx::TreeItemId] 
+    #   @return [String]
+    def get_path(*args) end
+    alias_method :path, :get_path
+    
+    # Fills the array paths with the selected directories and filenames.
+    # @param paths [Array<String>] 
+    # @return [void]
+    def get_paths(paths) end
+    alias_method :paths, :get_paths
+    
+    # Returns the root id for the tree control.
+    # @return [Wx::TreeItemId]
+    def get_root_id; end
+    alias_method :root_id, :get_root_id
+    
+    # Returns a pointer to the tree control.
+    # @return [Wx::TreeCtrl]
+    def get_tree_ctrl; end
+    alias_method :tree_ctrl, :get_tree_ctrl
+    
+    # Initializes variables.
+    # @return [void]
+    def init; end
+    
+    # Collapse and expand the tree, thus re-creating it from scratch.
+    # 
+    # May be used to update the displayed directory content.
+    # @return [void]
+    def re_create_tree; end
+    
+    # Sets the default path.
+    # @param path [String] 
+    # @return [void]
+    def set_default_path(path) end
+    alias_method :default_path=, :set_default_path
+    
+    # Sets the filter string.
+    # @param filter [String] 
+    # @return [void]
+    def set_filter(filter) end
+    alias_method :filter=, :set_filter
+    
+    # Sets the current filter index (zero-based).
+    # @param n [Integer] 
+    # @return [void]
+    def set_filter_index(n) end
+    alias_method :filter_index=, :set_filter_index
+    
+    # Sets the current path.
+    # @param path [String] 
+    # @return [void]
+    def set_path(path) end
+    alias_method :path=, :set_path
+    
+    # @param show [Boolean]  If true, hidden folders and files will be displayed by the control. If false, they will not be displayed.
+    # @return [void]
+    def show_hidden(show) end
+    
+    # Selects the given item.
+    # 
+    # In multiple selection controls, can be also used to deselect a currently selected item if the value of select is false. Existing selections are not changed. Only visible items can be (de)selected, otherwise use {Wx::GenericDirCtrl#expand_path}.
+    # @param path [String] 
+    # @param select [Boolean] 
+    # @return [void]
+    def select_path(path, select=true) end
+    
+    # Selects only the specified paths, clearing any previous selection.
+    # 
+    # Only supported when {Wx::DIRCTRL_MULTIPLE} is set.
+    # @param paths [Array<String>] 
+    # @return [void]
+    def select_paths(paths) end
+    
+    # Removes the selection from all currently selected items.
+    # @return [void]
+    def unselect_all; end
+    
+  end # GenericDirCtrl
+  
+
+end