wxruby3 0.9.2-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

data/lib/wx/doc/gen/pg/pg_validation_info.rb

@@ -293,6 +293,7 @@ module Wx::PG
   EVT_PG_COL_END_DRAG = 10344
   
   # Used to convey validation information to and from functions that actually perform validation.
+  # 
   # Mostly used in custom property classes.
   # 
   # 
@@ -300,6 +301,7 @@ module Wx::PG
   # @wxrb_require USE_PROPGRID
   class PGValidationInfo < ::Object
   
+    # 
     # 
     # Returns failure behaviour which is a combination of wxPropertyGrid Validation Failure behaviour Flags.
     # @return [Integer]

data/lib/wx/doc/gen/pg/property_grid.rb

@@ -7,6 +7,7 @@
 module Wx::PG
 
   # {Wx::PG::PropertyGrid} is a specialized grid for editing properties - in other words name = value pairs.
+  # 
   # List of ready-to-use property classes include strings, numbers, flag sets, fonts, colours and many others. It is possible, for example, to categorize properties, set up a complete tree-hierarchy, add more than two columns, and set arbitrary per-property attributes.
   # Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read {Wx::PG::PropertyGridInterface} class reference.
   # See also wxPropertyGrid Overview.
@@ -23,7 +24,7 @@ module Wx::PG
   # <b>Remark:</b>
   # <p>Use {Wx::PG::PropertyGrid#freeze} and {Wx::PG::PropertyGrid#thaw} respectively to disable and enable drawing. This will also delay sorting etc. miscellaneous calculations to the last possible moment.
   # </p>
-  # </div>>
+  # </div>
   # 
   # Category:  {Wx::PG::PropertyGrid}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
   #   </td><td> WXGTK Appearance
@@ -36,11 +37,12 @@ module Wx::PG
     include Wx::PG::PropertyGridInterface
   
     # Override in derived class to display error messages in custom manner (these message usually only result from validation failure).
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>If you implement this, then you also need to implement {Wx::PG::PropertyGrid#do_hide_property_error} - possibly to do nothing, if error does not need hiding (e.g. it was logged or shown in a message box).
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::PG::PropertyGrid#do_hide_property_error 
     # @param property [Wx::PG::PGProperty] 
     # @param msg [String] 
@@ -49,18 +51,21 @@ module Wx::PG
     
     # Override in derived class to hide an error displayed by {Wx::PG::PropertyGrid#do_show_property_error}.
     # 
+    # 
     # @see Wx::PG::PropertyGrid#do_show_property_error 
     # @param property [Wx::PG::PGProperty] 
     # @return [void]
     def do_hide_property_error(property) end
     
     # Return {Wx::StatusBar} that is used by this {Wx::PG::PropertyGrid}.
+    # 
     # You can reimplement this member function in derived class to override the default behaviour of using the top-level {Wx::Frame}'s status bar, if any.
     # @return [Wx::StatusBar]
     def get_status_bar; end
     alias_method :status_bar, :get_status_bar
     
     # Override to customize property validation failure behaviour.
+    # 
     # Return true if user is allowed to change to another property even if current has invalid value.
     # @param property [Wx::PG::PGProperty]  Property with entered an invalid value
     # @param invalidValue [Wx::Variant]  Value which failed in validation.
@@ -68,37 +73,41 @@ module Wx::PG
     def do_on_validation_failure(property, invalidValue) end
     
     # Override to customize resetting of property validation failure status.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Property is guaranteed to have flag {Wx::PG::PGPropertyFlags::PG_PROP_INVALID_VALUE} set. 
     # </p>
-    # </div>>
+    # </div>
     # @param property [Wx::PG::PGProperty] 
     # @return [void]
     def do_on_validation_failure_reset(property) end
     
     # Call when editor widget's contents is modified.
+    # 
     # For example, this is called when changes text in {Wx::TextCtrl} (used in {Wx::PG::StringProperty} and {Wx::PG::IntProperty}).
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This function should only be called by custom properties.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::PG::PGProperty#on_event 
     # @return [void]
     def editors_value_was_modified; end
     
     # Reverse of {Wx::PG::PropertyGrid#editors_value_was_modified}.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This function should only be called by custom properties. 
     # </p>
-    # </div>>
+    # </div>
     # @return [void]
     def editors_value_was_not_modified; end
     
     # Returns most up-to-date value of selected property.
+    # 
     # This will return value different from {Wx::PG::PropertyGrid#get_selected_property}->GetValue() only when text editor is activate and string edited by user represents valid, uncommitted property value.
     # @return [Wx::Variant]
     def get_uncommitted_property_value; end
@@ -116,22 +125,26 @@ module Wx::PG
     def show_property_error(id, msg) end
     
     # Call this from {Wx::PG::PGProperty#on_event} to cause property value to be changed after the function returns (with true as return value).
+    # 
     # {Wx::PG::PropertyGrid#value_change_in_event} must be used if you wish the application to be able to use {Wx::PG::EVT_PG_CHANGING} to potentially veto the given value.
     # @param variant [nil,String,Integer,Float,Time,Wx::Font,Wx::Colour,Wx::Variant,Array<WxVariant>,Array<String>,ObjectWx::PG::ColourPropertyValue] 
     # @return [void]
     def value_change_in_event(variant) end
     
     # You can use this member function, for instance, to detect in {Wx::PG::PGProperty#on_event} if {Wx::PG::PGProperty#set_value_in_event} was already called in {Wx::PG::PGEditor#on_event}.
+    # 
     # It really only detects if was value was changed using {Wx::PG::PGProperty#set_value_in_event}, which is usually used when a 'picker' dialog is displayed. If value was written by "normal means" in {Wx::PG::PGProperty#string_to_value} or IntToValue(), then this function will return false (on the other hand, {Wx::PG::PGProperty#on_event} is not even called in those cases).
     # @return [Boolean]
     def was_value_changed_in_event; end
     
     # @overload initialize()
     #   Two step constructor.
+    #   
     #   Call {Wx::PG::PropertyGrid#create} when this constructor is called to build up the {Wx::PG::PropertyGrid}
     #   @return [Wx::PG::PropertyGrid]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR)
     #   Constructor.
+    #   
     #   The styles to be used are styles valid for the {Wx::Window}.
     #   @see wxPropertyGrid Window Styles. 
     #   @param parent [Wx::Window] 
@@ -144,6 +157,7 @@ module Wx::PG
     def initialize(*args) end
     
     # Adds given key combination to trigger given action.
+    # 
     # Here is a sample code to make Enter key press move focus to the next property.
     # 
     # ```ruby
@@ -157,18 +171,20 @@ module Wx::PG
     def add_action_trigger(action, keycode, modifiers=0) end
     
     # Adds given property into selection.
+    # 
     # If {Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION} extra style is not used, then this has same effect as calling {Wx::PG::PropertyGrid#select_property}.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Multiple selection is not supported for categories. This means that if you have properties selected, you cannot add category to selection, and also if you have category selected, you cannot add other properties to selection. This member function will fail silently in these cases, even returning true. 
     # </p>
-    # </div>>
+    # </div>
     # @param id [String,Wx::PG::PGProperty] 
     # @return [Boolean]
     def add_to_selection(id) end
     
     # Creates label editor {Wx::TextCtrl} for given column, for property that is currently selected.
+    # 
     # When multiple selection is enabled, this applies to whatever property {Wx::PG::PropertyGrid#get_selection} returns.
     # @see Wx::PG::PropertyGrid#end_label_edit
     # @see  Wx::PG::PropertyGrid#make_column_editable 
@@ -177,13 +193,14 @@ module Wx::PG
     def begin_label_edit(colIndex=0) end
     
     # Changes value of a property, as if from an editor.
+    # 
     # Use this instead of {Wx::PG::PropertyGrid#set_property_value} if you need the value to run through validation process, and also send {Wx::PG::EVT_PG_CHANGED}.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
     # </p>
-    # </div>>
+    # </div>
     # 
     # Returns true if value was successfully changed.
     # @param id [String,Wx::PG::PGProperty] 
@@ -206,6 +223,7 @@ module Wx::PG
     def clear_action_triggers(action) end
     
     # Forces updating the value of property from the editor control.
+    # 
     # Note that {Wx::PG::EVT_PG_CHANGING} and {Wx::PG::EVT_PG_CHANGED} are dispatched using ProcessEvent, meaning your event handlers will be called immediately.
     # Returns true if anything was changed.
     # @param flags [Integer] 
@@ -213,6 +231,7 @@ module Wx::PG
     def commit_changes_from_editor(flags=0) end
     
     # Two step creation.
+    # 
     # Whenever the control is created without any parameters, use Create to actually create it. Don't access the control's public methods before this is called
     # @see wxPropertyGrid Window Styles. 
     # @param parent [Wx::Window] 
@@ -225,6 +244,7 @@ module Wx::PG
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR) end
     
     # Dedicates a specific keycode to {Wx::PG::PropertyGrid}.
+    # 
     # This means that such key presses will not be redirected to editor controls.
     # Using this function allows, for example, navigation between properties using arrow keys even when the focus is in the editor control.
     # @param keycode [Integer] 
@@ -232,17 +252,19 @@ module Wx::PG
     def dedicate_key(keycode) end
     
     # Enables or disables (shows/hides) categories according to parameter enable.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This functions deselects selected property, if any. Validation failure option {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY} is not respected, i.e. selection is cleared even if editor had invalid value. 
     # </p>
-    # </div>>
+    # </div>
     # @param enable [Boolean] 
     # @return [Boolean]
     def enable_categories(enable) end
     
     # Destroys label editor {Wx::TextCtrl}, if any.
     # 
+    # 
     # @see Wx::PG::PropertyGrid#begin_label_edit
     # @see  Wx::PG::PropertyGrid#make_column_editable 
     # @param commit [Boolean]  Use true (default) to store edited label text in property cell data.
@@ -250,12 +272,14 @@ module Wx::PG
     def end_label_edit(commit=true) end
     
     # Scrolls and/or expands items to ensure that the given item is visible.
+    # 
     # Returns true if something was actually done.
     # @param id [String,Wx::PG::PGProperty] 
     # @return [Boolean]
     def ensure_visible(id) end
     
     # Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).
+    # 
     # Minimum size for the grid to still display everything.
     # 
     # <div class="wxrb-remark">
@@ -268,7 +292,7 @@ module Wx::PG
     #     returns.
     #  
     # </p>
-    # </div>>
+    # </div>
     # @return [Wx::Size]
     def fit_columns; end
     
@@ -328,6 +352,7 @@ module Wx::PG
     alias_method :font_height, :get_font_height
     
     # Returns pointer to itself.
+    # 
     # Dummy function that enables same kind of code to use {Wx::PG::PropertyGrid} and {Wx::PG::PropertyGridManager}.
     # @return [Wx::PG::PropertyGrid]
     def get_grid; end
@@ -369,6 +394,7 @@ module Wx::PG
     alias_method :margin_width, :get_margin_width
     
     # Returns "root property".
+    # 
     # It does not have name, etc. and it is not visible. It is only useful for accessing its children.
     # @return [Wx::PG::PGProperty]
     def get_root; end
@@ -406,6 +432,7 @@ module Wx::PG
     alias_method :splitter_position, :get_splitter_position
     
     # Returns {Wx::TextCtrl} active in currently selected property, if any.
+    # 
     # Takes {Wx::OwnerDrawnComboBox} into account.
     # @return [Wx::TextCtrl]
     def get_editor_text_ctrl; end
@@ -413,6 +440,7 @@ module Wx::PG
     
     # Returns current appearance of unspecified value cells.
     # 
+    # 
     # @see Wx::PG::PropertyGrid#set_unspecified_value_appearance 
     # @return [Wx::PG::PGCell]
     def get_unspecified_value_appearance; end
@@ -445,12 +473,14 @@ module Wx::PG
     alias_method :editor_focused?, :is_editor_focused
     
     # Returns true if updating is frozen (i.e.
+    # 
     # {Wx::PG::PropertyGrid#freeze} called but not yet {Wx::PG::PropertyGrid#thaw} ).
     # @return [Boolean]
     def is_frozen; end
     alias_method :frozen?, :is_frozen
     
     # Makes given column editable by user.
+    # 
     # Note that column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using 
     # ```ruby
     #   # see Wx::PG::PGProperty#change_flag
@@ -464,13 +494,14 @@ module Wx::PG
     def make_column_editable(column, editable=true) end
     
     # It is recommended that you call this function any time your code causes {Wx::PG::PropertyGrid}'s top-level parent to change.
+    # 
     # {Wx::PG::PropertyGrid}'s OnIdle() handler should be able to detect most changes, but it is not perfect.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This function is automatically called from {Wx::PG::PropertyGrid}:: {Wx::PG::PropertyGrid#reparent} and {Wx::PG::PropertyGridManager#reparent}. You only need to use it if you reparent {Wx::PG::PropertyGrid} indirectly. 
     # </p>
-    # </div>>
+    # </div>
     # @param newTLP [Wx::Window]  New top-level parent that is about to be set. Old top-level parent window should still exist as the current one.
     # @return [void]
     def on_tlp_changing(newTLP) end
@@ -490,18 +521,21 @@ module Wx::PG
     
     # Resets column sizes and splitter positions, based on proportions.
     # 
+    # 
     # @see Wx::PG::PropertyGridInterface#set_column_proportion 
     # @param enableAutoResizing [Boolean]  If true, automatic column resizing is enabled (only applicable if window style {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} is used).
     # @return [void]
     def reset_column_sizes(enableAutoResizing=false) end
     
     # Removes given property from selection.
+    # 
     # If property is not selected, an assertion failure will occur.
     # @param id [String,Wx::PG::PGProperty] 
     # @return [Boolean]
     def remove_from_selection(id) end
     
     # Selects a property.
+    # 
     # Editor widget is automatically created, but not focused unless focus is true.
     # 
     # returns true if selection finished successfully. Usually only fails if current value in editor is not valid.
@@ -510,13 +544,13 @@ module Wx::PG
     # <b>Remark:</b>
     # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG::EVT_PG_SELECTED}.
     # </p>
-    # </div>>
+    # </div>
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This clears any previous selection.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::PG::PropertyGridInterface#clear_selection 
     # @param id [String,Wx::PG::PGProperty]  Property to select (name or pointer).
     # @param focus [Boolean]  If true, move keyboard focus to the created editor right away.
@@ -536,6 +570,7 @@ module Wx::PG
     alias_method :caption_text_colour=, :set_caption_text_colour
     
     # Sets default cell background colour - applies to property cells.
+    # 
     # Note that appearance of editor widgets may not be affected.
     # @param col [Wx::Colour,String,Symbol] 
     # @return [void]
@@ -549,6 +584,7 @@ module Wx::PG
     alias_method :cell_disabled_text_colour=, :set_cell_disabled_text_colour
     
     # Sets default cell text colour - applies to property name and value text.
+    # 
     # Note that appearance of editor widgets may not be affected.
     # @param col [Wx::Colour,String,Symbol] 
     # @return [void]
@@ -604,11 +640,12 @@ module Wx::PG
     alias_method :selection_text_colour=, :set_selection_text_colour
     
     # Sets x coordinate of the splitter.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used. 
     # </p>
-    # </div>>
+    # </div>
     # @param newxpos [Integer] 
     # @param col [Integer] 
     # @return [void]
@@ -622,13 +659,14 @@ module Wx::PG
     alias_method :splitter_left=, :set_splitter_left
     
     # Sets appearance of value cells representing an unspecified property value.
+    # 
     # Default appearance is blank.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::PG::PGProperty#set_value_to_unspecified
     # @see  Wx::PG::PGProperty#is_value_unspecified 
     # @param cell [Wx::PG::PGCell] 
@@ -637,6 +675,7 @@ module Wx::PG
     alias_method :unspecified_value_appearance=, :set_unspecified_value_appearance
     
     # Sets vertical spacing.
+    # 
     # Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.
     # @param vspacing [Integer] 
     # @return [void]
@@ -644,6 +683,7 @@ module Wx::PG
     alias_method :vertical_spacing=, :set_vertical_spacing
     
     # Set virtual width for this particular page.
+    # 
     # Width -1 indicates that the virtual width should be disabled.
     # @param width [Integer] 
     # @return [void]
@@ -665,12 +705,14 @@ module Wx::PG
     def draw_item_and_value_related(p) end
     
     # This static function enables or disables automatic use of {get_translation} for following strings: {Wx::PG::EnumProperty} list labels, {Wx::PG::FlagsProperty} child property labels.
+    # 
     # Default is false.
     # @param enable [Boolean] 
     # @return [void]
     def self.auto_get_translation(enable) end
     
     # Registers a new editor class.
+    # 
     # Returns pointer to the editor class instance that should be used.
     # @param editor [Wx::PG::PGEditor] 
     # @param name [String] 

data/lib/wx/doc/gen/pg/property_grid_event.rb

@@ -7,6 +7,7 @@
 module Wx::PG
 
   # A property grid event holds information about events associated with {Wx::PG::PropertyGrid} objects.
+  # 
   # To process input from a property grid control, use these event handler macros to direct input to member functions that take a {Wx::PG::PropertyGridEvent} argument.
   # ### Events emitted by this class
   # 
@@ -46,7 +47,7 @@ module Wx::PG
   
     # @overload initialize(commandType=0, id=0)
     #   Constructor.
-    #   @param commandType [Wx::Slider::EventType] 
+    #   @param commandType [Wx::StaticLine::EventType] 
     #   @param id [Integer] 
     #   @return [Wx::PG::PropertyGridEvent]
     # @overload initialize(event)
@@ -61,29 +62,32 @@ module Wx::PG
     alias_method :can_veto?, :can_veto
     
     # Returns the column index associated with this event.
+    # 
     # For the column dragging events, it is the column to the left of the splitter being dragged
     # @return [Integer]
     def get_column; end
     alias_method :column, :get_column
     
     # Returns highest level non-category, non-root parent of property for which event occurred.
+    # 
     # Useful when you have nested properties with children.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>If immediate parent is root or category, this will return the property itself. 
     # </p>
-    # </div>>
+    # </div>
     # @return [Wx::PG::PGProperty]
     def get_main_parent; end
     alias_method :main_parent, :get_main_parent
     
     # Returns property associated with this event.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>You should assume that this property can always be NULL. For instance, {Wx::PG::EVT_PG_SELECTED} is emitted not only when a new property is selected, but also when selection is cleared by user activity. 
     # </p>
-    # </div>>
+    # </div>
     # @return [Wx::PG::PGProperty]
     def get_property; end
     alias_method :property, :get_property
@@ -94,29 +98,32 @@ module Wx::PG
     alias_method :validation_failure_behavior, :get_validation_failure_behavior
     
     # Returns name of the associated property.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Property name is stored in event, so it remains accessible even after the associated property or the property grid has been deleted. 
     # </p>
-    # </div>>
+    # </div>
     # @return [String]
     def get_property_name; end
     alias_method :property_name, :get_property_name
     
     # Returns value of the associated property.
+    # 
     # Works for all event types, but for {Wx::PG::EVT_PG_CHANGING} this member function returns the value that is pending, so you can call {Wx::PG::PropertyGridEvent#veto} if the value is not satisfactory.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Property value is stored in event, so it remains accessible even after the associated property or the property grid has been deleted. 
     # </p>
-    # </div>>
+    # </div>
     # @return [Wx::Variant]
     def get_property_value; end
     alias_method :property_value, :get_property_value
     
     # Returns value of the associated property.
     # 
+    # 
     # @see Wx::PG::PropertyGridEvent#get_property_value 
     # @return [Wx::Variant]
     def get_value; end
@@ -135,6 +142,7 @@ module Wx::PG
     alias_method :property=, :set_property
     
     # Set override validation failure behaviour.
+    # 
     # Only effective if {Wx::PG::PropertyGridEvent#veto} was also called, and only allowed if event type is {Wx::PG::EVT_PG_CHANGING}.
     # @param flags [Integer] 
     # @return [void]
@@ -142,6 +150,7 @@ module Wx::PG
     alias_method :validation_failure_behavior=, :set_validation_failure_behavior
     
     # Sets custom failure message for this time only.
+    # 
     # Only applies if {Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_SHOW_MESSAGE} is set in validation failure flags.
     # @param message [String] 
     # @return [void]
@@ -149,13 +158,14 @@ module Wx::PG
     alias_method :validation_failure_message=, :set_validation_failure_message
     
     # Call this from your event handler to veto action that the event is signaling.
+    # 
     # You can only veto a shutdown if {Wx::PG::PropertyGridEvent#can_veto} returns true.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Currently only {Wx::PG::EVT_PG_CHANGING} supports vetoing. 
     # </p>
-    # </div>>
+    # </div>
     # @param veto [Boolean] 
     # @return [void]
     def veto(veto=true) end