wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,116 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A collection of secrets, sometimes called a key chain.
+  # 
+  # This class provides access to the secrets stored in the OS-provided facility, e.g. credentials manager under MSW, keychain under macOS or Freedesktop-compliant password storage mechanism such as GNOME keyring under Unix systems.
+  # Currently only the access to the default keychain/ring is provided using {Wx::SecretStore.get_default} method, support for other ones could be added in the future. After calling this method just call {Wx::SecretStore#save} to store a password entered by user and then call {Wx::SecretStore#load} to retrieve it during next program execution. See page_samples_secretstore for an example of using this class.
+  # The service parameter of the methods in this class should describe the purpose of the password and be unique to your program, e.g. it could be "MyCompany/MyProgram/SomeServer". Note that the server name must be included in the string to allow storing passwords for more than one server.
+  # Notice that this class is always available under MSW (except when using MinGW32 which doesn't provide the required wincred.h header) and macOS but requires libsecret (see https://developer.gnome.org/libsecret/) under Unix and may not be compiled in if it wasn't found. You can check {Wx::Setup::USE_SECRETSTORE} to test for this. Moreover, retrieving the default secret store may also fail under Unix during run-time if the desktop environment doesn't provide one, so don't forget to call {Wx::SecretStore#is_ok} to check for this too.
+  # Example of storing credentials using this class: 
+  # ```ruby
+  #   store = Wx::SecretStore.get_default
+  #   rc, err = store.ok?
+  #   if rc
+  #     unless store.save('MyApp/MyService', username, password)
+  #       Wx.log_warning('Failed to save credentials to the system secret store.')
+  #     end
+  #   else
+  #     Wx.log_warning("This system doesn't support storing passwords securely (#{err}).")
+  #   end
+  # ```
+  # 
+  # And to load it back: 
+  # ```ruby
+  #   store = Wx::SecretStore.get_default
+  #   rc, _ = store.ok?
+  #   if rc
+  #     password = Wx::SecretValue.new
+  #     rc, username = store.load('MyApp/MyService', password)
+  #     if rc
+  #       # ... use the password ... 
+  #     end
+  #   end
+  # ```
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_SECRETSTORE
+  class SecretStore < ::Object
+  
+    # Returns the default secrets collection to use.
+    # 
+    # Call {Wx::SecretStore#is_ok} on the returned object to check if this method succeeded.
+    # Note that this method may show a dialog to the user under some platforms, so it can take an arbitrarily long time to return.
+    # @return [Wx::SecretStore]
+    def self.get_default; end
+    
+    # Check if this object can actually be used.
+    # Returns true if the object can be used.
+    # Returns false and an error message describing the reason if not.
+    # @return [Array(Boolean,String)]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Store a username/password combination.
+    # 
+    # The service name should be user readable and unique.
+    # If a secret with the same service name already exists, it will be overwritten with the new value. In particular, notice that it is not currently allowed to store passwords for different usernames for the same service, even if the underlying platform API supports this (as is the case for macOS but not MSW).
+    # Returns false after logging an error message if an error occurs, otherwise returns true indicating that the secret has been stored and can be retrieved by calling {Wx::SecretStore#load} later.
+    # @param service [String] 
+    # @param username [String] 
+    # @param password [Wx::SecretValue] 
+    # @return [Boolean]
+    def save(service, username, password) end
+    
+    # Look up the username/password for the given service.
+    # 
+    # If no username/password is found for the given service, false is returned.
+    # Otherwise the function returns true and the username and updates the provided password argument.
+    # @param service [String] 
+    # @param password [Wx::SecretValue] 
+    # @return [Array(Boolean,String)]
+    def load(service, password) end
+    
+    # Delete a previously stored username/password combination.
+    # 
+    # If anything was deleted, returns true. Otherwise returns false and logs an error if any error other than not finding any matches occurred.
+    # @param service [String] 
+    # @return [Boolean]
+    def delete(service) end
+    
+  end # SecretStore
+  
+  # Represents the value of a secret in {Wx::SecretStore}.
+  # 
+  # Immutable value-like class which tries to ensure that the secret value will be removed once it's not needed any more.
+  # 
+  # Category:  {Wx::Miscellaneous}
+  # @note Due to a bug using binary secrets will not work for WXGTK wxWidgets<=3.2.4 (WXOSX and WXMSW work fine). This has been fixed for later versions.
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_SECRETSTORE
+  class SecretValue < ::Object
+  
+    # Check if a secret is not empty.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Compare with another secret for equality.
+    # @param other [Wx::SecretValue] 
+    # @return [Boolean]
+    def ==(other) end
+    
+  end # SecretValue
+  
+
+end

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

@@ -0,0 +1,110 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # {Wx::Simplebook} is a control showing exactly one of its several pages.
+  # 
+  # It implements {Wx::BookCtrlBase} class interface but doesn't allow the user to change the page being displayed, unlike all the other book control classes, only the program can do it.
+  # This class is created in the same manner as any other {Wx::BookCtrl} but then the program will typically call {Wx::Simplebook#change_selection} to show different pages. See the page_samples_notebook for an example of {Wx::Simplebook} in action.
+  # Notice that it is often convenient to use {Wx::Simplebook#show_new_page} instead of the base class {Wx::Simplebook#add_page}.
+  # There are no special styles defined for this class as it has no visual appearance of its own.
+  # There are also no special events, this class reuses {Wx::EVT_BOOKCTRL_PAGE_CHANGING} and {Wx::EVT_BOOKCTRL_PAGE_CHANGED} events for the events it generates if the program calls {Wx::Simplebook#set_selection}.
+  # 
+  # Category:  Book Controls
+  # @see Wx::BookCtrl
+  # @see  Wx::Notebook
+  # @see  page_samples_notebook
+  # 
+  # 
+  # @wxrb_require USE_AUI|USE_NOTEBOOK|USE_LISTBOOK|USE_CHOICEBOOK|USE_TOOLBOOK|USE_TREEBOOK
+  class Simplebook < BookCtrlBase
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   Use {Wx::Simplebook#create} later to really create the control.
+    #   @return [Wx::Simplebook]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
+    #   Constructs a simple book control.
+    #   @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 [Wx::Simplebook]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''), &block)
+    #   Constructs a simple book control.
+    #   @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] 
+    #   @yieldparam [Wx::Simplebook] win new instance
+    #   @return [Wx::Simplebook]
+    def initialize(*args) end
+    
+    # Really create the window of an object created using default constructor.
+    # @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=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
+    
+    # Set the effects to use for showing and hiding the pages.
+    # 
+    # This method allows specifying the effects passed to {Wx::Window#show_with_effect} and {Wx::Window#hide_with_effect} respectively when the pages need to be shown or hidden.
+    # By default, no effects are used, but as the pages are only changed by the program and not the user himself, it may be useful to use some visual effects to make the changes more noticeable.
+    # @see Wx::Simplebook#set_effects_timeouts 
+    # @param showEffect [Wx::ShowEffect]  The effect to use for showing the newly selected page.
+    # @param hideEffect [Wx::ShowEffect]  The effect to use for hiding the previously selected page.
+    # @return [void]
+    def set_effects(showEffect, hideEffect) end
+    
+    # Set the same effect to use for both showing and hiding the pages.
+    # 
+    # This is the same as <code>SetEffects(effect, effect)</code>.
+    # @see Wx::Simplebook#set_effect_timeout 
+    # @param effect [Wx::ShowEffect] 
+    # @return [void]
+    def set_effect(effect) end
+    alias_method :effect=, :set_effect
+    
+    # Set the effect timeout to use for showing and hiding the pages.
+    # 
+    # This method allows configuring the timeout arguments passed to {Wx::Window#show_with_effect} and {Wx::Window#hide_with_effect} if a non-default effect is used.
+    # If this method is not called, default, system-dependent timeout is used.
+    # @see Wx::Simplebook#set_effects 
+    # @param showTimeout [unsigned]  Timeout of the show effect, in milliseconds.
+    # @param hideTimeout [unsigned]  Timeout of the hide effect, in milliseconds.
+    # @return [void]
+    def set_effects_timeouts(showTimeout, hideTimeout) end
+    
+    # Set the same effect timeout to use for both showing and hiding the pages.
+    # 
+    # This is the same as <code>SetEffectsTimeouts(timeout, timeout)</code>.
+    # @see Wx::Simplebook#set_effect 
+    # @param timeout [unsigned] 
+    # @return [void]
+    def set_effect_timeout(timeout) end
+    alias_method :effect_timeout=, :set_effect_timeout
+    
+    # Add a new page and show it immediately.
+    # 
+    # This is simply a thin wrapper around the base class {Wx::BookCtrlBase#add_page} method using empty label (which is unused by this class anyhow) and selecting the new page immediately.
+    # @param page [Wx::Window] 
+    # @return [Boolean]
+    def show_new_page(page) end
+    
+  end # Simplebook
+  
+
+end

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

@@ -0,0 +1,89 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  CHOICEDLG_STYLE = 536877141
+  
+  # This class represents a dialog that shows a list of strings, and allows the user to select one.
+  # 
+  # Double-clicking on a list item is equivalent to single-clicking and then pressing OK.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::OK}: Show an OK button. 
+  # 
+  # - {Wx::CANCEL}: Show a Cancel button. 
+  # 
+  # - {Wx::GeometryCentre::CENTRE}: Centre the message. 
+  # 
+  # Category:  Common Dialogs
+  # @see wxSingleChoiceDialog Overview
+  # @see  Wx::MultiChoiceDialog 
+  # 
+  # 
+  # @wxrb_require USE_CHOICEDLG
+  class SingleChoiceDialog < Dialog
+  
+    # @overload initialize(parent, message, caption, choices, style=Wx::CHOICEDLG_STYLE, pos=Wx::DEFAULT_POSITION)
+    #   Constructor, taking an array of {Wx::String} choices and optional client data.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Use {Wx::SingleChoiceDialog#show_modal} to show the dialog.
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  Parent window.
+    #   @param message [String]  Message to show on the dialog.
+    #   @param caption [String]  The dialog caption.
+    #   @param choices [Array<String>]  An array of strings, or a string list, containing the choices.
+    #   @param style [Integer]  A dialog style (bitlist) containing flags chosen from standard dialog styles and the ones listed in the class documentation. The default value is equivalent to {Wx::DEFAULT_DIALOG_STYLE} | {Wx::RESIZE_BORDER} | {Wx::OK} | {Wx::CANCEL} | {Wx::GeometryCentre::CENTRE}.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
+    #   @return [Wx::SingleChoiceDialog]
+    # @overload initialize(parent, message, caption, choices, style=Wx::CHOICEDLG_STYLE, pos=Wx::DEFAULT_POSITION, &block)
+    #   Constructor, taking an array of {Wx::String} choices and optional client data.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Use {Wx::SingleChoiceDialog#show_modal} to show the dialog.
+    #   </p>
+    #   </div>
+    #   @param parent [Wx::Window]  Parent window.
+    #   @param message [String]  Message to show on the dialog.
+    #   @param caption [String]  The dialog caption.
+    #   @param choices [Array<String>]  An array of strings, or a string list, containing the choices.
+    #   @param style [Integer]  A dialog style (bitlist) containing flags chosen from standard dialog styles and the ones listed in the class documentation. The default value is equivalent to {Wx::DEFAULT_DIALOG_STYLE} | {Wx::RESIZE_BORDER} | {Wx::OK} | {Wx::CANCEL} | {Wx::GeometryCentre::CENTRE}.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Dialog position.
+    #   @yieldparam [Wx::SingleChoiceDialog] win new instance
+    #   @return [Wx::SingleChoiceDialog]
+    def initialize(*args) end
+    
+    # Returns the index of selected item.
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Returns the selected string.
+    # @return [String]
+    def get_string_selection; end
+    alias_method :string_selection, :get_string_selection
+    
+    # Sets the index of the initially selected item.
+    # @param selection [Integer] 
+    # @return [void]
+    def set_selection(selection) end
+    alias_method :selection=, :set_selection
+    
+    # Shows the dialog, returning either {Wx::StandardID::ID_OK} or {Wx::StandardID::ID_CANCEL}.
+    # @return [Integer]
+    def show_modal; end
+    
+  end # SingleChoiceDialog
+  
+
+end