wxruby3 1.6.1 → 1.8.0

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

@@ -0,0 +1,68 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # An empty, "null" {Wx::Validator} instance.
+  # 
+  DEFAULT_VALIDATOR = nil
+  
+  # {Wx::Validator} is the base class for a family of validator classes that mediate between a class of control, and application data.
+  # 
+  # A validator has three major roles:
+  # 
+  # - To transfer data from a C++ variable or own storage to and from a control.
+  # - To validate data in a control, and show an appropriate error message.
+  # - To filter events (such as keystrokes), thereby changing the behaviour of the associated control.
+  # 
+  # Validators can be plugged into controls dynamically.
+  # To specify a default, "null" validator, use {Wx::DEFAULT_VALIDATOR}.
+  # For more information, please see wxValidator Overview.
+  # 
+  # Category:  {Wx::Validators}
+  # Predefined objects/pointers: {Wx::DEFAULT_VALIDATOR}
+  # @see wxValidator Overview
+  # @see  Wx::TextValidator
+  # @see  Wx::GenericValidator
+  # @see  Wx::IntegerValidator
+  # @see  Wx::FloatingPointValidator 
+  # 
+  # 
+  # @wxrb_require USE_VALIDATORS
+  class Validator < EvtHandler
+  
+    # All validator classes must implement the {Wx::Validator#clone} function, which returns an identical copy of itself.
+    # 
+    # This is because validators are passed to control constructors as references which must be copied. Unlike objects such as pens and brushes, it does not make sense to have a reference counting scheme to do this cloning because all validators should have separate data.
+    # This base function returns nil.
+    # @return [Wx::Object]
+    def clone; end
+    
+    # Returns the window associated with the validator.
+    # @return [Wx::Window]
+    def get_window; end
+    alias_method :window, :get_window
+    
+    # This overridable function is called when the value in the associated window must be validated.
+    # 
+    # false if the value in the window is not valid; you may pop up an error dialog.
+    # @param parent [Wx::Window]  The parent of the window associated with the validator.
+    # @return [Boolean]
+    def validate(parent) end
+    
+    # This functions switches on or turns off the error sound produced by the validators if an invalid key is pressed.
+    # @param suppress [Boolean]  If true, error sound is not played when a validator detects an error. If false, error sound is enabled.
+    # @return [void]
+    def self.suppress_bell_on_error(suppress=true) end
+    
+    # Returns if the error sound is currently disabled.
+    # @return [Boolean]
+    def self.is_silent; end
+    
+  end # Validator
+  
+
+end

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

@@ -0,0 +1,294 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The {Wx::Variant} class represents a container for any type.
+  # 
+  # A variant's value can be changed at run time, possibly to a different type of value.
+  # In wxRuby Wx::Variant is the only available Wx variant class (unlike in C++) and almost exclusively for
+  # use in combination with the property grid classes (see the {Wx::PG} module).
+  # 
+  # By default Wx::Variant can store values of type bool, {Integer}, {Float}, {String}, {Time} (or {Date} / {DateTime}), {Array} of {String}, 
+  # {Array} of {Wx::Variant}, {Wx::Font}, {Wx::Colour} and {Wx::ColourPropertyValue}.
+  # In addition Wx::Variant can store any Ruby {Object}.
+  # 
+  # An optional name member is associated with a Wx::Variant.
+  # 
+  # In wxRuby Wx::Variant also provides the standard conversion methods #to_i, #to_s and #to_f for supported
+  # value types. In case of incompatible value types these methods will raise a {TypeError} exception.
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_VARIANT
+  class Variant < Object
+  
+    # Appends a value to the list.
+    # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
+    # @return [void]
+    def append(value) end
+    
+    # Makes the variant null by deleting the internal data and set the name to {Wx::EmptyString}.
+    # @return [void]
+    def clear; end
+    
+    # Deletes the contents of the list.
+    # @return [void]
+    def clear_list; end
+    
+    # Deletes the zero-based item from the list.
+    # @param item [Integer] 
+    # @return [Boolean]
+    def delete(item) end
+    
+    # Returns the number of elements in the list.
+    # @return [Integer]
+    def get_count; end
+    alias_method :count, :get_count
+    
+    # Inserts a value at the front of the list.
+    # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
+    # @return [void]
+    def insert(value) end
+    
+    # Makes an empty list.
+    # 
+    # This differs from a null variant which has no data; a null list is of type list, but the number of elements in the list is zero.
+    # @return [void]
+    def null_list; end
+    
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [String] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [String] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [String] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Integer] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Boolean] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Float] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Integer] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Integer] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Object] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Wx::Object] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Array<Wx::Variant>] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Array<String>] 
+    #   @return [Boolean]
+    # @overload ==(value)
+    #   Equality test operator.
+    #   @param value [Time,Date,DateTime] 
+    #   @return [Boolean]
+    def ==(*args) end
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::Variant]
+    # @overload initialize(data, name=(''))
+    #   Constructs a variant directly with a {Wx::VariantData} object.
+    #   
+    #   {Wx::Variant} will take ownership of the {Wx::VariantData} and will not increase its reference count.
+    #   @param data [Object] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(variant)
+    #   Constructs a variant from another variant by increasing the reference count.
+    #   @param variant [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a string.
+    #   @param value [String] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a long.
+    #   @param value [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a bool.
+    #   @param value [Boolean] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a double.
+    #   @param value [Float] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a {Wx::LongLong}.
+    #   @param value [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a {Wx::ULongLong}.
+    #   @param value [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(value, name=(''))
+    #   Constructs a variant from a list of variants.
+    #   @param value [Array<Wx::Variant>] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(val, name=(''))
+    #   Constructs a variant from a {Wx::DateTime}.
+    #   @param val [Time,Date,DateTime] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    # @overload initialize(val, name=(''))
+    #   Constructs a variant from a {Wx::ArrayString}.
+    #   @param val [Array<String>] 
+    #   @param name [String] 
+    #   @return [Wx::Variant]
+    def initialize(*args) end
+    
+    # Returns the string array value.
+    # @return [Array<String>]
+    def get_array_string; end
+    alias_method :array_string, :get_array_string
+    
+    # Returns the boolean value.
+    # @return [Boolean]
+    def get_bool; end
+    alias_method :bool, :get_bool
+    
+    # Returns the character value.
+    # @return [String]
+    def get_char; end
+    alias_method :char, :get_char
+    
+    # Returns a pointer to the internal variant data.
+    # 
+    # To take ownership of this data, you must call its Wx::VariantData#inc_ref method. When you stop using it, Wx::VariantData#dec_ref must be called as well.
+    # @return [Object]
+    def get_object; end
+    alias_method :object, :get_object
+    
+    # Returns the date value.
+    # @return [Time,Date,DateTime]
+    def get_date_time; end
+    alias_method :date_time, :get_date_time
+    
+    # Returns the floating point value.
+    # @return [Float]
+    def get_double; end
+    alias_method :double, :get_double
+    
+    # Returns the integer value.
+    # @return [Integer]
+    def get_long; end
+    alias_method :long, :get_long
+    
+    # Returns the signed 64-bit integer value.
+    # @return [Integer]
+    def get_long_long; end
+    alias_method :long_long, :get_long_long
+    
+    # Returns a constant reference to the variant name.
+    # @return [Wx::String]
+    def get_name; end
+    alias_method :name, :get_name
+    
+    # Gets the string value.
+    # @return [String]
+    def get_string; end
+    alias_method :string, :get_string
+    
+    # Returns the value type as a string.
+    # 
+    # The built-in types are:
+    # 
+    # - "bool"
+    # - "char"
+    # - "datetime"
+    # - "double"
+    # - "list"
+    # - "long"
+    # - "longlong"
+    # - "string"
+    # - "ulonglong"
+    # - "arrstring"
+    # 
+    # If the variant is null, the value type returned is the string "null" (not the empty string). 
+    #         
+    # If the variant contains an arbitrary Ruby {Object}, the value type returned is the result of `variant.get_object.class.name`.
+    # @return [String]
+    def get_type; end
+    alias_method :type, :get_type
+    
+    # Returns the unsigned 64-bit integer value.
+    # @return [Integer]
+    def get_u_long_long; end
+    alias_method :u_long_long, :get_u_long_long
+    
+    # Returns true if there is no data associated with this variant, false if there is data.
+    # @return [Boolean]
+    def is_null; end
+    alias_method :null?, :is_null
+    
+    # Returns true if type matches the type of the variant, false otherwise.
+    # @param type [String] 
+    # @return [Boolean]
+    def is_type(type) end
+    alias_method :type?, :is_type
+    
+    # Makes the variant null by deleting the internal data.
+    # @return [void]
+    def make_null; end
+    
+    # Makes a string representation of the variant value (for any type).
+    # @return [String]
+    def make_string; end
+    
+    # Returns true if value matches an element in the list.
+    # @param value [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
+    # @return [Boolean]
+    def member(value) end
+    
+    # Makes sure that any data associated with this variant is not shared with other variants.
+    # 
+    # For this to work, Wx::VariantData#clone must be implemented for the data types you are working with. Wx::VariantData#clone is implemented for all the default data types.
+    # @return [Boolean]
+    def unshare; end
+    
+  end # Variant
+  
+
+end

data/lib/wx/doc/gen/web/event_list.rb

@@ -0,0 +1,95 @@
+# ----------------------------------------------------------------------------
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# ----------------------------------------------------------------------------
+
+
+module Wx
+
+  class EvtHandler
+
+    # @!group WEB Event handler methods
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_CREATED} event, generated when the object is fully initialized. For the backends using asynchronous initialization, such as {Wx::WebViewChromium}, most of this class member functions can be only used once this event is received. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_created(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_NAVIGATING} event, generated before trying to get a resource. This event may be vetoed to prevent navigating to this resource. Note that if the displayed HTML document has several frames, one such event will be generated per frame. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_navigating(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_NAVIGATED} event generated after it was confirmed that a resource would be requested. This event may not be vetoed. Note that if the displayed HTML document has several frames, one such event will be generated per frame. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_navigated(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_LOADED} event generated when the document is fully loaded and displayed. Note that if the displayed HTML document has several frames, one such event will be generated per frame. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_loaded(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_ERROR} event generated when a navigation error occurs. The integer associated with this event will be a {Wx::WEB::WebViewNavigationError} item. The string associated with this event may contain a backend-specific more precise error message/code. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_error(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_NEWWINDOW} event, generated when a new window is created. You must handle this event if you want anything to happen, for example to load the page in a new window or tab. For usage details see {Wx::WEB::WebViewWindowFeatures}. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_newwindow(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_NEWWINDOW_FEATURES} event, generated when window features are available for the new window. For usage details see {Wx::WEB::WebViewWindowFeatures}. only available in wxWidgets 3.3.0 or later. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_newwindow_features(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_WINDOW_CLOSE_REQUESTED} event, generated when a window is requested to be closed. only available in wxWidgets 3.3.0 or later. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_window_close_requested(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_TITLE_CHANGED} event, generated when the page title changes. Use GetString to get the title. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_title_changed(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_FULLSCREEN_CHANGED} event, generated when the page wants to enter or leave fullscreen. Use GetInt to get the status. Not implemented for the IE backend and is only available in wxWidgets 3.1.5 or later. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_fullscreen_changed(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED} event only available in wxWidgets 3.1.5 or later. For usage details see {Wx::WEB::WebView#add_script_message_handler}. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_script_message_received(id, meth = nil, &block) end
+    
+    # Process a {Wx::WEB::EVT_WEBVIEW_SCRIPT_RESULT} event only available in wxWidgets 3.1.6 or later. For usage details see {Wx::WEB::WebView#run_script_async}. 
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_script_result(id, meth = nil, &block) end
+    
+    # Processes a {Wx::WEB::EVT_WEBVIEW_BROWSING_DATA_CLEARED} event.
+    # @param [Integer,Wx::Enum,Wx::Window,Wx::MenuItem,Wx::ToolBarTool,Wx::Timer] id window/control id
+    # @param [String,Symbol,Method,Proc] meth (name of) method or handler proc
+    # @yieldparam [Wx::WEB::WebViewEvent] event the event to handle
+    def evt_webview_browsing_data_cleared(id, meth = nil, &block) end
+    
+    # @!endgroup
+
+  end
+
+end