wxruby3 0.9.0-x64-mingw-ucrt → 0.9.2-x64-mingw-ucrt

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

@@ -14,10 +14,11 @@ module Wx::PG
   
   # 
   # 
-  # == wxPropertyGrid Window Styles
+  # ## wxPropertyGrid Window Styles
   # 
   # SetWindowStyleFlag method can be used to modify some of these at run-time.
   # 
+  # @wxrb_require USE_PROPGRID
   class PG_WINDOW_STYLES < Wx::Enum
   
     # This will cause Sort() automatically after an item is added.
@@ -82,6 +83,7 @@ module Wx::PG
   # 
   # 
   # 
+  # @wxrb_require USE_PROPGRID
   class PG_EX_WINDOW_STYLES < Wx::Enum
   
     # Speeds up switching to {Wx::PG::PG_WINDOW_STYLES::PG_HIDE_CATEGORIES} mode.
@@ -124,7 +126,7 @@ module Wx::PG
     # 
     PG_EX_ENABLE_TLP_TRACKING = Wx::PG::PG_EX_WINDOW_STYLES.new(67108864)
     
-    # Don't show divider above {Wx::PG::PropertyGridManager} toolbar (wxMSW only).
+    # Don't show divider above {Wx::PG::PropertyGridManager} toolbar (WXMSW only).
     # 
     PG_EX_NO_TOOLBAR_DIVIDER = Wx::PG::PG_EX_WINDOW_STYLES.new(134217728)
     
@@ -152,8 +154,9 @@ module Wx::PG
   
   # 
   # 
-  # == wxPropertyGrid Validation Failure behaviour Flags
+  # ## wxPropertyGrid Validation Failure behaviour Flags
   # 
+  # @wxrb_require USE_PROPGRID
   class PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS < Wx::Enum
   
     # Prevents user from leaving property unless value is valid.
@@ -188,10 +191,11 @@ module Wx::PG
   
   # 
   # 
-  # == wxPropertyGrid Action Identifiers
+  # ## wxPropertyGrid Action Identifiers
   # 
   # These are used with {Wx::PG::PropertyGrid#add_action_trigger} and {Wx::PG::PropertyGrid#clear_action_triggers}.
   # 
+  # @wxrb_require USE_PROPGRID
   class PG_KEYBOARD_ACTIONS < Wx::Enum
   
     # 
@@ -293,6 +297,7 @@ module Wx::PG
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_PROPGRID
   class PGValidationInfo < ::Object
   
     # 

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

@@ -11,28 +11,36 @@ module Wx::PG
   # 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.
   # 
-  # == Window Styles
+  # ## Window Styles
   # 
   # See wxPropertyGrid Window Styles.
   # 
-  # == Event Handling
+  # ## Event Handling
   # 
   # Please see {Wx::PG::PropertyGridEvent} for the documentation of all event types you can use with {Wx::PG::PropertyGrid}.
-  # 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.
   # 
-  # === 
+  # <div class="wxrb-remark">
+  # <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>>
   # 
-  # Category:  {Wx::PG::PropertyGrid}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::PG::PropertyGrid}  <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>
   # 
+  # @wxrb_require USE_PROPGRID
   class PropertyGrid < ScrolledControl
   
     include Wx::PG::PropertyGridInterface
   
     # Override in derived class to display error messages in custom manner (these message usually only result from validation failure).
-    # 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).
+    # <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>>
     # @see Wx::PG::PropertyGrid#do_hide_property_error 
     # @param property [Wx::PG::PGProperty] 
     # @param msg [String] 
@@ -60,20 +68,33 @@ module Wx::PG
     def do_on_validation_failure(property, invalidValue) end
     
     # Override to customize resetting of property validation failure status.
-    # Property is guaranteed to have flag {Wx::PG::PGPropertyFlags::PG_PROP_INVALID_VALUE} set.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Property is guaranteed to have flag {Wx::PG::PGPropertyFlags::PG_PROP_INVALID_VALUE} set. 
+    # </p>
+    # </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}).
-    # This function should only be called by custom properties.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function should only be called by custom properties.
+    # </p>
+    # </div>>
     # @see Wx::PG::PGProperty#on_event 
     # @return [void]
     def editors_value_was_modified; end
     
     # Reverse of {Wx::PG::PropertyGrid#editors_value_was_modified}.
-    # This function should only be called by custom properties.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function should only be called by custom properties. 
+    # </p>
+    # </div>>
     # @return [void]
     def editors_value_was_not_modified; end
     
@@ -109,7 +130,7 @@ module Wx::PG
     #   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::PropertyGridNameStr)
+    # @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. 
@@ -137,7 +158,12 @@ module Wx::PG
     
     # 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}.
-    # 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.
+    # 
+    # <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>>
     # @param id [String,Wx::PG::PGProperty] 
     # @return [Boolean]
     def add_to_selection(id) end
@@ -152,7 +178,12 @@ module Wx::PG
     
     # 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}.
-    # Since this function sends {Wx::PG::EVT_PG_CHANGED}, it should not be called from EVT_PG_CHANGED handler.
+    # 
+    # <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>>
     # 
     # Returns true if value was successfully changed.
     # @param id [String,Wx::PG::PGProperty] 
@@ -191,7 +222,7 @@ module Wx::PG
     # @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=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PropertyGridNameStr) end
+    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.
@@ -201,7 +232,11 @@ module Wx::PG
     def dedicate_key(keycode) end
     
     # Enables or disables (shows/hides) categories according to parameter enable.
-    # 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.
+    # <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>>
     # @param enable [Boolean] 
     # @return [Boolean]
     def enable_categories(enable) end
@@ -223,12 +258,17 @@ module Wx::PG
     # Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).
     # Minimum size for the grid to still display everything.
     # 
-    # Does not work well with {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style.     This function only works properly if grid size prior to call was
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Does not work well with {Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER} window style.     This function only works properly if grid size prior to call was
     #     already fairly large.
     # 
     #     Note that you can also get calculated column widths by calling
     #     GetState->GetColumnWidth() immediately after this function
     #     returns.
+    #  
+    # </p>
+    # </div>>
     # @return [Wx::Size]
     def fit_columns; end
     
@@ -426,7 +466,11 @@ module Wx::PG
     # 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.
     # 
-    # 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.
+    # <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>>
     # @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
@@ -462,9 +506,17 @@ module Wx::PG
     # 
     # returns true if selection finished successfully. Usually only fails if current value in editor is not valid.
     # 
-    # In wxWidgets 2.9 and later, this function no longer sends {Wx::PG::EVT_PG_SELECTED}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>In wxWidgets 2.9 and later, this function no longer sends {Wx::PG::EVT_PG_SELECTED}.
+    # </p>
+    # </div>>
     # 
-    # This clears any previous selection.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This clears any previous selection.
+    # </p>
+    # </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.
@@ -552,7 +604,11 @@ module Wx::PG
     alias_method :selection_text_colour=, :set_selection_text_colour
     
     # Sets x coordinate of the splitter.
-    # 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.
+    # <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>>
     # @param newxpos [Integer] 
     # @param col [Integer] 
     # @return [void]
@@ -567,7 +623,12 @@ module Wx::PG
     
     # Sets appearance of value cells representing an unspecified property value.
     # Default appearance is blank.
-    # If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.
+    # 
+    # <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>>
     # @see Wx::PG::PGProperty#set_value_to_unspecified
     # @see  Wx::PG::PGProperty#is_value_unspecified 
     # @param cell [Wx::PG::PGCell] 

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

@@ -8,7 +8,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
+  # ### Events emitted by this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::PG::PropertyGridEvent} events.
   # Event handler methods for events emitted by this class:
@@ -39,15 +39,14 @@ module Wx::PG
   # 
   # - {Wx::EvtHandler#evt_pg_col_end_drag}(id, meth = nil, &block): Respond to {Wx::PG::EVT_PG_COL_END_DRAG} event, generated after column resize by user has finished. 
   # 
-  # === 
-  # 
   # Category:  {Wx::PG::PropertyGrid}, {Wx::Events}
   # 
+  # @wxrb_require USE_PROPGRID
   class PropertyGridEvent < CommandEvent
   
     # @overload initialize(commandType=0, id=0)
     #   Constructor.
-    #   @param commandType [Wx::CommandLinkButton::EventType] 
+    #   @param commandType [Wx::Slider::EventType] 
     #   @param id [Integer] 
     #   @return [Wx::PG::PropertyGridEvent]
     # @overload initialize(event)
@@ -69,13 +68,22 @@ module Wx::PG
     
     # Returns highest level non-category, non-root parent of property for which event occurred.
     # Useful when you have nested properties with children.
-    # If immediate parent is root or category, this will return the property itself.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If immediate parent is root or category, this will return the property itself. 
+    # </p>
+    # </div>>
     # @return [Wx::PG::PGProperty]
     def get_main_parent; end
     alias_method :main_parent, :get_main_parent
     
     # Returns property associated with this event.
-    # 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.
+    # <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>>
     # @return [Wx::PG::PGProperty]
     def get_property; end
     alias_method :property, :get_property
@@ -86,14 +94,23 @@ module Wx::PG
     alias_method :validation_failure_behavior, :get_validation_failure_behavior
     
     # Returns name of the associated property.
-    # Property name is stored in event, so it remains accessible even after the associated property or the property grid has been deleted.
+    # <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>>
     # @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.
-    # Property value is stored in event, so it remains accessible even after the associated property or the property grid has been deleted.
+    # 
+    # <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>>
     # @return [Wx::Variant]
     def get_property_value; end
     alias_method :property_value, :get_property_value
@@ -133,7 +150,12 @@ module Wx::PG
     
     # 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.
-    # Currently only {Wx::PG::EVT_PG_CHANGING} supports vetoing.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Currently only {Wx::PG::EVT_PG_CHANGING} supports vetoing. 
+    # </p>
+    # </div>>
     # @param veto [Boolean] 
     # @return [void]
     def veto(veto=true) end