wxruby3 0.9.7 → 1.0.0

data/lib/wx/doc/secret_store.rb

@@ -0,0 +1,55 @@
+# :stopdoc:
+# Copyright (c) 2023 M.J.N. Corino, The Netherlands
+#
+# This software is released under the MIT license.
+# :startdoc:
+
+
+module Wx
+
+  class SecretStore
+
+    # Wipes the secret data.
+    # @param [String] secret string containing secret data
+    # @return [void]
+    def self.wipe(secret); end
+
+  end
+
+  class SecretValue
+
+    # @overload initialize()
+    #   Creates an empty secret value (not the same as an empty password).
+    #   @return [Wx::SecretValue]
+    # @overload initialize(secret)
+    #   Creates a secret value from the given string.
+    #   The secret argument may contain NUL bytes.
+    #   Any UTF-8 encoded (or encodable; wxRuby will attempt re-encoding as UTF-8 for any string not encoded UTF-8 or ASCII-8BIT) string will be stored as UTF-8 encoded string.
+    #   In these cases use {#get_as_string} if needing to compare the original string to a restored string.
+    #   Otherwise the string will be stored as ASCII-8BIT encoded string.
+    #   In these cases use {#get_data} if needing to compare the original string to a restored string.
+    #   See {#==} for comparing secret values opaquely.
+    #   @param secret [String]
+    #   @return [Wx::SecretValue]
+    # @overload initialize(other)
+    #   Creates a copy of an existing secret.
+    #   @param other [Wx::SecretValue]
+    #   @return [Wx::SecretValue]
+    def initialize(*args) end
+
+    # Returns a copy of the secret data as an ASCII-8BIT encoded String.
+    # Be aware this could be binary data and may contain embedded NUL characters.
+    # For more security {Wx::SecretStore.wipe} should be used to wipe the secret data after use.
+    # @return [String] secret data
+    def get_data; end
+
+    # Returns a copy of the secret data as an UTF-8 encoded String.
+    # Make sure to use this method only if sure that the secret originally stored was indeed
+    # UTF-8 data as otherwise the returned string will not match the stored data.
+    # For more security {Wx::SecretStore.wipe} should be used to wipe the secret data after use.
+    # @return [String] secret data
+    def get_as_string; end
+
+  end
+
+end

data/lib/wx/doc/svg_file_dc.rb

@@ -18,7 +18,7 @@ module Wx
     # @param [Float] dpi resolution for SVG image
     # @param [String] title readable name for the SVG document
     # @yieldparam [Wx::SVGFileDC] dc the SVGFileDC instance to paint on
-    # @return [Object] result of the block
+    # @return [::Object] result of the block
     def self.draw_on(filename, width=320, height=240, dpi=72, title='') end
 
   end

data/lib/wx/doc/textctrl.rb

@@ -62,7 +62,7 @@ module Wx
 
     # Appends the string representation of `obj` to the text value of the control.
     # Calls #to_s to get the string representation of `obj`.
-    # @param [Object] obj
+    # @param [::Object] obj
     # @return [self]
     def <<(obj) end
 

data/lib/wx/doc/tree_ctrl.rb

@@ -37,7 +37,7 @@ module Wx
     #
     # Returns an invalid tree item if there are no further children.
     # @param [Wx::TreeItemId] parent_id the id of the parent tree item for which to iterate children
-    # @param [Object] cookie cookie value as returned from previous #get_first_cild or #get_next_child call.
+    # @param [::Object] cookie cookie value as returned from previous #get_first_cild or #get_next_child call.
     # @return [Array(Wx::TreeItemId, Object)] first child item id (if any) and cookie value
     def get_next_child(parent_id, cookie) end
 
@@ -74,7 +74,7 @@ module Wx
     # @param [Integer] pos child item's position to insert before
     # @param [Integer] image image index for unselected item
     # @param [Integer] selImage image index for selected item
-    # @param data [Object]
+    # @param data [::Object]
     # @return [Wx::TreeItemId] id of inserted tree item
     def insert_item_before(parent, pos, text, image=-1, selImage=-1, data=nil) end
 

data/lib/wx/doc/validator.rb

@@ -22,7 +22,7 @@ module Wx
     # Should retrieve and return the data from the associated window (#get_window).
     # By default returns nil (which indicates there is no custom data to transfer).
     # Overload for customized functionality.
-    # @return [Object] retrieved data from window
+    # @return [::Object] retrieved data from window
     def do_transfer_from_window; end
     protected :do_transfer_from_window
 
@@ -30,7 +30,7 @@ module Wx
     # Should transfer the given data to the associated window and return true if successful.
     # By default does nothing and just returns true.
     # Overload for customized functionality.
-    # @param [Object] data
+    # @param [::Object] data
     # @return [Boolean]
     def do_transfer_to_window(data) end
     protected :do_transfer_to_window
@@ -60,7 +60,7 @@ module Wx
       #   win.set_validator(val)
       #
       # @param [String,Symbol,Method,Proc] meth (name of) method or event handling proc; to be supplied when no block is given
-      # @yieldparam [Object] data the data retrieved from the window
+      # @yieldparam [::Object] data the data retrieved from the window
       def on_transfer_from_window(meth=nil, &block) end
 
       # Installs a callback handler to provide the data to transfer to the associated window.
@@ -85,13 +85,13 @@ module Wx
       #   win.set_validator(val)
       #
       # @param [String,Symbol,Method,Proc] meth (name of) method or event handling proc; to be supplied when no block is given
-      # @yieldreturn [Object] the data to transfer to the window
+      # @yieldreturn [::Object] the data to transfer to the window
       def on_transfer_to_window(meth=nil, &block) end
 
       # Method called with data transferred from window.
       # By default will call the on_transfer_from_window handler if defined.
       # Returns true if successful or none defined.
-      # @param [Object] data
+      # @param [::Object] data
       # @return [Boolean]
       def do_on_transfer_from_window(data) end
       protected :do_on_transfer_from_window
@@ -100,7 +100,7 @@ module Wx
       # By default will call the on_transfer_to_window handler if defined.
       # Returns the handler's result if successful.
       # Otherwise returns nil.
-      # @return [Object]
+      # @return [::Object]
       def do_on_transfer_to_window; end
       protected :do_on_transfer_to_window
 

data/lib/wx/doc/variant.rb

@@ -16,7 +16,7 @@ module Wx
     # Returns an enumerator when no block is given.
     # @overload each(&block)
     #   @yieldparam item [Wx::Variant] variant list item
-    #   @return [Object] result of last block execution
+    #   @return [::Object] result of last block execution
     # @overload each
     #   @return [Enumerator] an enumerator
     def each; end
@@ -52,7 +52,7 @@ module Wx
     #   @return [self]
     # @overload assign(value)
     #   Equality test operator.
-    #   @param value [Object]
+    #   @param value [::Object]
     #   @return [self]
     # @overload assign(value)
     #   Equality test operator.

data/lib/wx/doc/window.rb

@@ -44,13 +44,14 @@ module Wx
     # Creates a Wx::PaintDC when called from an evt_paint handler and a
     # Wx::ClientDC otherwise.
     # @yieldparam [Wx::PaintDC,Wx::ClientDC] dc dc to paint on
-    # @return [Object] result from block
+    # @return [::Object] result from block
     def paint; end
 
-    # Similar to #paint but this time creates a Wx::AutoBufferedPaintDC when called
+    # Similar to #paint but this time creates a buffered paint DC (which will be either a 'regular' Wx::PaintDC if
+    # the platform natively supports double buffering or a Wx::BufferedPaintDC otherwise) when called
     # from an evt_paint handler and a Wx::ClientDC otherwise.
-    # @yieldparam [Wx::AutoBufferedPaintDC,Wx::ClientDC] dc dc to paint on
-    # @return [Object] result from block
+    # @yieldparam [Wx::PaintDC,Wx::BufferedPaintDC,Wx::ClientDC] dc dc to paint on
+    # @return [::Object] result from block
     def paint_buffered; end
 
     # Yield each child window to the given block.

data/lib/wx/grid/keyword_defs.rb

@@ -13,5 +13,5 @@
 # wxGrid 	A grid (table) window
 Wx::define_keyword_ctors(Wx::GRID::Grid) do
   wx_ctor_params :id, :pos, :size, :style => Wx::WANTS_CHARS
-  wx_ctor_params :name => 'grid'
+  wx_ctor_params :name => Wx::GRID_NAME_STR
 end

data/lib/wx/html/keyword_defs.rb

@@ -13,16 +13,16 @@
 # wxHtmlWindow - Control for displaying HTML
 Wx::define_keyword_ctors(Wx::HTML::HtmlWindow) do
   wx_ctor_params :id, :pos, :size, :style => Wx::HTML::HW_DEFAULT_STYLE
-  wx_ctor_params :name => 'htmlWindow'
+  wx_ctor_params :name => Wx::HTML_WINDOW_NAME_STR
 end
 
 # wxHtmlListBox 	A listbox showing HTML content
 Wx::define_keyword_ctors(Wx::HTML::HtmlListBox) do
-  wx_ctor_params :id, :pos, :size, :style, :name => 'HtmlListBox'
+  wx_ctor_params :id, :pos, :size, :style, :name => Wx::HTML_LIST_BOX_NAME_STR
 end
 
 Wx::define_keyword_ctors(Wx::HTML::SimpleHtmlListBox) do
   wx_ctor_params :id, :pos, :size
   wx_ctor_params :choices => []
-  wx_ctor_params :style, :validator, :name => 'SimpleHtmlListBox'
+  wx_ctor_params :style, :validator, :name => Wx::SIMPLE_HTML_LIST_BOX_NAME_STR
 end