wxruby3 0.9.0.pre.rc.1-x64-mingw-ucrt → 0.9.0.pre.rc.3-x64-mingw-ucrt

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

@@ -312,6 +312,7 @@ module Wx::PG
   # In sections below we cover few related topics.
   # 
   # - Supplied Ready-to-use Property Classes 
+  # 
   # - Creating Custom Properties
   # 
   # == Supplied Ready-to-use Property Classes
@@ -319,24 +320,43 @@ module Wx::PG
   # Here is a list and short description of supplied fully-functional property classes. They are located in either {Wx::props.h} or {Wx::advprops.h}.
   # 
   # - {Wx::PG::ArrayStringProperty} 
+  # 
   # - {Wx::PG::BoolProperty} 
+  # 
   # - {Wx::PG::ColourProperty} 
+  # 
   # - {Wx::PG::CursorProperty} 
+  # 
   # - {Wx::PG::DateProperty} 
+  # 
   # - {Wx::PG::DirProperty} 
+  # 
   # - {Wx::PG::EditEnumProperty} 
+  # 
   # - {Wx::PG::EnumProperty} 
+  # 
   # - {Wx::PG::FileProperty} 
+  # 
   # - {Wx::PG::FlagsProperty} 
+  # 
   # - {Wx::PG::FloatProperty} 
+  # 
   # - {Wx::PG::FontProperty} 
+  # 
   # - {Wx::PG::ImageFileProperty} 
+  # 
   # - {Wx::PG::IntProperty} 
+  # 
   # - {Wx::PG::LongStringProperty} 
+  # 
   # - {Wx::PG::MultiChoiceProperty} 
+  # 
   # - {Wx::PG::PropertyCategory} 
+  # 
   # - {Wx::PG::StringProperty} 
+  # 
   # - {Wx::PG::SystemColourProperty} 
+  # 
   # - {Wx::PG::UIntProperty}
   # 
   # == wxPropertyCategory
@@ -347,7 +367,9 @@ module Wx::PG
   # 
   # Simple string property.
   # Supported special attributes:
-  # - {Wx::PG::PG_STRING_PASSWORD}: Set to true in order to echo value as asterisks and to use {Wx::TE_PASSWORD} on the editor ({Wx::TextCtrl}).- {Wx::PG::PG_ATTR_AUTOCOMPLETE}: Set to true to enable auto-completion (use a {Wx::ArrayString} value), and is also supported by any property that happens to use a {Wx::TextCtrl}-based editor. 
+  # 
+  # - {Wx::PG::PG_STRING_PASSWORD}: Set to true in order to echo value as asterisks and to use {Wx::TE_PASSWORD} on the editor ({Wx::TextCtrl}).
+  # - {Wx::PG::PG_ATTR_AUTOCOMPLETE}: Set to true to enable auto-completion (use a {Wx::ArrayString} value), and is also supported by any property that happens to use a {Wx::TextCtrl}-based editor. 
   # {Wx::PG::StringProperty} has a special trait: if it has value of "<composed>", and also has child properties, then its displayed value becomes composition of child property values, similar as with {Wx::PG::FontProperty}, for instance.
   # 
   # == wxIntProperty
@@ -386,13 +408,19 @@ module Wx::PG
   # ```
   # 
   # Supported special attributes:
-  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX} to specify acceptable value range.- {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
+  # 
+  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX} to specify acceptable value range.
+  # - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
   # 
   # == wxUIntProperty
   # 
   # Like {Wx::PG::IntProperty}, but displays value as unsigned int. To set the prefix used globally, manipulate {Wx::PG::PG_UINT_PREFIX} string attribute. To set the globally used base, manipulate {Wx::PG::PG_UINT_BASE} int attribute. Regardless of current prefix, understands (hex) values starting with both "0x" and "$" (apart from edit mode). Like {Wx::PG::IntProperty}, {Wx::PG::UIntProperty} seamlessly supports 64-bit unsigned integers (i.e. {Wx::ULongLong}). Same {Wx::Variant} safety rules apply.
   # Supported special attributes:
-  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specifies acceptable value range.- {Wx::PG::PG_UINT_BASE}: Defines base. Valid constants are {Wx::PG::PG_BASE_OCT}, {Wx::PG::PG_BASE_DEC}, {Wx::PG::PG_BASE_HEX} and {Wx::PG::PG_BASE_HEXL} (lowercase characters). Arbitrary bases are <b>not</b> supported.- {Wx::PG::PG_UINT_PREFIX}: Defines displayed prefix. Possible values are {Wx::PG::PG_PREFIX_NONE}, {Wx::PG::PG_PREFIX_0x} and {Wx::PG::PG_PREFIX_DOLLAR_SIGN}. Only {Wx::PG::PG_PREFIX_NONE} works with decimal and octal numbers.- {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
+  # 
+  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specifies acceptable value range.
+  # - {Wx::PG::PG_UINT_BASE}: Defines base. Valid constants are {Wx::PG::PG_BASE_OCT}, {Wx::PG::PG_BASE_DEC}, {Wx::PG::PG_BASE_HEX} and {Wx::PG::PG_BASE_HEXL} (lowercase characters). Arbitrary bases are <b>not</b> supported.
+  # - {Wx::PG::PG_UINT_PREFIX}: Defines displayed prefix. Possible values are {Wx::PG::PG_PREFIX_NONE}, {Wx::PG::PG_PREFIX_0x} and {Wx::PG::PG_PREFIX_DOLLAR_SIGN}. Only {Wx::PG::PG_PREFIX_NONE} works with decimal and octal numbers.
+  # - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
   # For example how to use seamless 64-bit integer support, see {Wx::PG::IntProperty} documentation (just use {Wx::ULongLong} instead of {Wx::LongLong}).
   # 
   # == wxFloatProperty
@@ -400,13 +428,18 @@ module Wx::PG
   # Like {Wx::PG::StringProperty}, but converts text to a double-precision floating point. Default float-to-text precision is 6 decimals, but this can be changed by modifying {Wx::PG::PG_FLOAT_PRECISION} attribute.
   # Note that when displaying the value, sign is omitted if the resulting textual representation is effectively zero (for example, -0.0001 with precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike what C standard library does, but should result in better end-user experience in almost all cases.
   # Supported special attributes:
-  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specifies acceptable value range.- {Wx::PG::PG_FLOAT_PRECISION}: Sets the (max) precision used when floating point value is rendered as text. The default -1 means shortest floating-point 6-digit representation.- {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
+  # 
+  # - {Wx::PG::PG_ATTR_MIN}, {Wx::PG::PG_ATTR_MAX}: Specifies acceptable value range.
+  # - {Wx::PG::PG_FLOAT_PRECISION}: Sets the (max) precision used when floating point value is rendered as text. The default -1 means shortest floating-point 6-digit representation.
+  # - {Wx::PG::PG_ATTR_SPINCTRL_STEP}, {Wx::PG::PG_ATTR_SPINCTRL_WRAP}, {Wx::PG::PG_ATTR_SPINCTRL_MOTION}: Sets SpinCtrl editor parameters. 
   # 
   # == wxBoolProperty
   # 
   # Represents a boolean value. {Wx::Choice} is used as editor control, by the default. {Wx::PG::PG_BOOL_USE_CHECKBOX} attribute can be set to true in order to use check box instead.
   # Supported special attributes:
-  # - {Wx::PG::PG_BOOL_USE_CHECKBOX}: If set to true uses check box editor instead of combo box.- {Wx::PG::PG_BOOL_USE_DOUBLE_CLICK_CYCLING}: If set to true cycles combo box instead showing the list. 
+  # 
+  # - {Wx::PG::PG_BOOL_USE_CHECKBOX}: If set to true uses check box editor instead of combo box.
+  # - {Wx::PG::PG_BOOL_USE_DOUBLE_CLICK_CYCLING}: If set to true cycles combo box instead showing the list. 
   # 
   # == wxLongStringProperty
   # 
@@ -543,19 +576,24 @@ module Wx::PG
   # - ::{Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the file dialog.
   # - ::{Wx::PG::PG_FILE_DIALOG_STYLE}: Sets a specific {Wx::FileDialog} style for the file dialog.
   # - ::{Wx::PG::PG_FILE_WILDCARD}: Sets wildcard (see {Wx::FileDialog} for format details), "All files..." is default.
-  # - {Wx::PG::PG_FILE_SHOW_FULL_PATH}: Default true. When false, only the file name is shown (i.e. drive and directory are hidden).- {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.- {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files. 
+  # 
+  # - {Wx::PG::PG_FILE_SHOW_FULL_PATH}: Default true. When false, only the file name is shown (i.e. drive and directory are hidden).
+  # - {Wx::PG::PG_FILE_SHOW_RELATIVE_PATH}: If set, then the filename is shown relative to the given path string.
+  # - {Wx::PG::PG_FILE_INITIAL_PATH}: Sets the initial path of where to look for files. 
   # 
   # == wxColourProperty
   # 
   # <b>Useful alternate editor:</b> Choice.
   # Represents {Wx::Colour}. {Wx::Button} is used to trigger a colour picker dialog. There are various sub-classing opportunities with this class. See below in {Wx::PG::SystemColourProperty} section for details.
   # Supported special attributes:
+  # 
   # - {Wx::PG::PG_COLOUR_HAS_ALPHA}: If set to true allows user to edit the alpha colour component. 
   # 
   # == wxFontProperty
   # 
   # Represents {Wx::Font}. Various sub-properties are used to edit individual subvalues.
   # Supported special attributes:
+  # 
   # - {Wx::PG::PG_DIALOG_TITLE}: Sets a specific title for the font dialog.
   # 
   # == wxSystemColourProperty
@@ -600,7 +638,7 @@ module Wx::PG
   # 
   # == wxCursorProperty
   # 
-  # Represents a {Wx::Cursor}. {Wx::Choice} is used to edit the value. Drop-down list has cursor images under some ({Wx::MSW}) platforms.
+  # Represents a {Wx::Cursor}. {Wx::Choice} is used to edit the value. Drop-down list has cursor images under some (wxMSW) platforms.
   # 
   # == Creating Custom Properties
   # 
@@ -689,7 +727,9 @@ module Wx::PG
   class PGProperty < Object
   
     # This virtual function is called after m_value has been set.
-    # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::PGProperty#on_set_value} will not be called.- m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::PGProperty#on_set_value} provides a good opportunity to convert supported values into internal type.- Default implementation does nothing.
+    # - If m_value was set to Null variant (i.e. unspecified value), {Wx::PG::PGProperty#on_set_value} will not be called.
+    # - m_value may be of any variant type. Typically properties internally support only one variant type, and as such {Wx::PG::PGProperty#on_set_value} provides a good opportunity to convert supported values into internal type.
+    # - Default implementation does nothing.
     # @return [void]
     def on_set_value; end
     
@@ -702,7 +742,7 @@ module Wx::PG
     # 
     # - Default implementation always returns true.
     # @param value [Wx::Variant] 
-    # @param validationInfo [Wx::PGValidationInfo] 
+    # @param validationInfo [Wx::PG::PGValidationInfo] 
     # @return [true,false]
     def validate_value(value, validationInfo) end
     
@@ -721,7 +761,10 @@ module Wx::PG
     # Converts integer (possibly a choice selection) into {Wx::Variant} value appropriate for this property.
     # Returns true if resulting {Wx::Variant} value was different.
     # 
-    # - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.- Default implementation simply assign given int to m_value.- If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.- You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
+    # - If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method.
+    # - Default implementation simply assign given int to m_value.
+    # - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
+    # - You might want to take into account that m_value is Mull variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).
     # @param variant [Wx::Variant]  On function entry this is the old value (should not be {Wx::NullVariant} in normal cases). Translated value must be assigned back to it.
     # @param number [Integer]  Integer to be translated into variant.
     # @param argFlags [Integer]  If {Wx::PG::PG_MISC_ARG_FLAGS::PG_FULL_VALUE} is set, returns complete, storable value instead of displayable one.
@@ -758,7 +801,9 @@ module Wx::PG
     # Returns size of the custom painted image in front of property.
     # This method must be overridden to return non-default value if OnCustomPaint is to be called.
     # 
-    # - Default behaviour is to return {size(0,0)}, which means no image.- Default image width or height is indicated with dimension -1.- You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
+    # - Default behaviour is to return {size(0,0)}, which means no image.
+    # - Default image width or height is indicated with dimension -1.
+    # - You can also return {Wx::PG::PG_DEFAULT_IMAGE_SIZE} which equals {Wx::DEFAULT_SIZE}.
     # @param item [Integer]  Normally -1, but can be an index to the property's list of items.
     # @return [Wx::Size]
     def on_measure_image(item=-1) end
@@ -773,7 +818,7 @@ module Wx::PG
     # return true if any changes in value should be reported.
     # 
     # - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent.
-    # @param propgrid [Wx::PropertyGrid] 
+    # @param propgrid [Wx::PG::PropertyGrid] 
     # @param wnd_primary [Wx::Window] 
     # @param event [Wx::Event] 
     # @return [true,false]
@@ -819,7 +864,7 @@ module Wx::PG
     def child_changed(thisValue, childIndex, childValue) end
     
     # Returns pointer to an instance of used editor.
-    # @return [Wx::PGEditor]
+    # @return [Wx::PG::PGEditor]
     def do_get_editor_class; end
     
     # Returns pointer to the {Wx::Validator} that should be used with the editor of this property (NULL for no validator).
@@ -847,11 +892,14 @@ module Wx::PG
     # If property's {Wx::PG::PGProperty#on_measure_image} returns size that has height != 0 but less than row height ( < 0 has special meanings), {Wx::PG::PropertyGrid} calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case {Wx::PG::PGProperty#on_measure_image} returned higher height than row height).
     # NOTE: Following applies when {Wx::PG::PGProperty#on_measure_image} returns a "flexible" height ( using <code>wxPG_FLEXIBLE_SIZE(W,H)</code> macro), which implies variable height items: If (rect.x+rect.width) is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.
     # 
-    # - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.- Due to technical reasons, rect's height will be default even if custom height was reported during measure call.- Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.- Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.
+    # - You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels.
+    # - Due to technical reasons, rect's height will be default even if custom height was reported during measure call.
+    # - Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified.
+    # - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.
     # @see Wx::PG::PGProperty#value_to_string 
     # @param dc [Wx::DC]  {Wx::DC} to paint on.
     # @param rect [Wx::Rect]  Box reserved for custom graphics. Includes surrounding rectangle, if any. If x+width is < 0, then this is a measure item call (see above).
-    # @param paintdata [Wx::PGPaintData]  {Wx::PG::PGPaintData} structure with much useful data about painted item. 
+    # @param paintdata [Wx::PG::PGPaintData]  {Wx::PG::PGPaintData} structure with much useful data about painted item. 
     #   ```
     #     struct wxPGPaintData
     #     {
@@ -901,7 +949,7 @@ module Wx::PG
     
     # Returns instance of a new {Wx::PG::PGEditorDialogAdapter} instance, which is used when user presses the (optional) button next to the editor control;.
     # Default implementation returns NULL (i.e. no action is generated when button is pressed).
-    # @return [Wx::PGEditorDialogAdapter]
+    # @return [Wx::PG::PGEditorDialogAdapter]
     def get_editor_dialog; end
     alias_method :editor_dialog, :get_editor_dialog
     
@@ -920,7 +968,7 @@ module Wx::PG
     
     # Adds a private child property.
     # If you use this instead of {Wx::PG::PropertyGridInterface#insert} or {Wx::PG::PropertyGridInterface#append_in}, then property's parental type will automatically be set up to {Wx::PG::PGPropertyFlags::PG_PROP_AGGREGATE}. In other words, all properties of this property will become private.
-    # @param prop [Wx::PGProperty] 
+    # @param prop [Wx::PG::PGProperty] 
     # @return [void]
     def add_private_child(prop) end
     
@@ -937,7 +985,7 @@ module Wx::PG
     # {Wx::PG::PropertyGrid} is not automatically refreshed by this function.
     # @see Wx::PG::PGProperty#insert_child
     # @see  Wx::PG::PGProperty#add_private_child 
-    # @param childProperty [Wx::PGProperty] 
+    # @param childProperty [Wx::PG::PGProperty] 
     # @return [Wx::PG::PGProperty]
     def append_child(childProperty) end
     
@@ -1038,7 +1086,7 @@ module Wx::PG
     # Returns editor used for given column.
     # NULL for no editor.
     # @param column [Integer] 
-    # @return [Wx::PGEditor]
+    # @return [Wx::PG::PGEditor]
     def get_column_editor(column) end
     alias_method :column_editor, :get_column_editor
     
@@ -1051,7 +1099,7 @@ module Wx::PG
     # Returns {Wx::PG::PGCell} of given column.
     # const version of this member function returns 'default' {Wx::PG::PGCell} object if the property itself didn't hold cell data.
     # @param column [Integer] 
-    # @return [Wx::PGCell]
+    # @return [Wx::PG::PGCell]
     def get_cell_or_default(column) end
     alias_method :cell_or_default, :get_cell_or_default
     
@@ -1074,7 +1122,7 @@ module Wx::PG
     alias_method :children_height, :get_children_height
     
     # Returns read-only reference to property's list of choices.
-    # @return [Wx::PGChoices]
+    # @return [Wx::PG::PGChoices]
     def get_choices; end
     alias_method :choices, :get_choices
     
@@ -1111,7 +1159,7 @@ module Wx::PG
     
     # Returns {Wx::PG::PGEditor} that will be used and created when property becomes selected.
     # Returns more accurate value than {Wx::PG::PGProperty#do_get_editor_class}.
-    # @return [Wx::PGEditor]
+    # @return [Wx::PG::PGEditor]
     def get_editor_class; end
     alias_method :editor_class, :get_editor_class
     
@@ -1121,12 +1169,12 @@ module Wx::PG
     alias_method :hint_text, :get_hint_text
     
     # Returns property grid where property lies.
-    # @return [Wx::PropertyGrid]
+    # @return [Wx::PG::PropertyGrid]
     def get_grid; end
     alias_method :grid, :get_grid
     
     # Returns owner {Wx::PG::PropertyGrid}, but only if one is currently on a page displaying this property.
-    # @return [Wx::PropertyGrid]
+    # @return [Wx::PG::PropertyGrid]
     def get_grid_if_displayed; end
     alias_method :grid_if_displayed, :get_grid_if_displayed
     
@@ -1150,7 +1198,7 @@ module Wx::PG
     alias_method :index_in_parent, :get_index_in_parent
     
     # Returns last visible child property, recursively.
-    # @return [Wx::PGProperty]
+    # @return [Wx::PG::PGProperty]
     def get_last_visible_sub_item; end
     alias_method :last_visible_sub_item, :get_last_visible_sub_item
     
@@ -1261,7 +1309,7 @@ module Wx::PG
     
     # Returns index of given child property.
     # {Wx::NOT_FOUND} if given property is not child of this.
-    # @param p [Wx::PGProperty] 
+    # @param p [Wx::PG::PGProperty] 
     # @return [Integer]
     def index(p) end
     
@@ -1273,7 +1321,7 @@ module Wx::PG
     # @see Wx::PG::PGProperty#append_child
     # @see  Wx::PG::PGProperty#add_private_child 
     # @param index [Integer] 
-    # @param childProperty [Wx::PGProperty] 
+    # @param childProperty [Wx::PG::PGProperty] 
     # @return [Wx::PG::PGProperty]
     def insert_child(index, childProperty) end
     
@@ -1311,7 +1359,7 @@ module Wx::PG
     
     # Returns true if candidateParent is some parent of this property.
     # Use, for example, to detect if item is inside collapsed section.
-    # @param candidateParent [Wx::PGProperty] 
+    # @param candidateParent [Wx::PG::PGProperty] 
     # @return [true,false]
     def is_some_parent(candidateParent) end
     alias_method :some_parent?, :is_some_parent
@@ -1381,7 +1429,7 @@ module Wx::PG
     # @overload set_editor(editor)
     #   Sets editor for a property.
     #   For custom editors, use pointer you received from {Wx::PG::PropertyGrid.register_editor_class}.
-    #   @param editor [Wx::PGEditor]  For builtin editors, use {Wx::PGEditor_X}, where X is builtin editor's name (TextCtrl, Choice, etc. see {Wx::PG::PGEditor} documentation for full list).
+    #   @param editor [Wx::PG::PGEditor]  For builtin editors, use {Wx::PGEditor_X}, where X is builtin editor's name (TextCtrl, Choice, etc. see {Wx::PG::PGEditor} documentation for full list).
     #   @return [void]
     # @overload set_editor(editorName)
     #   Sets editor for a property, by editor name.
@@ -1392,7 +1440,7 @@ module Wx::PG
     
     # Sets cell information for given column.
     # @param column [Integer] 
-    # @param cell [Wx::PGCell] 
+    # @param cell [Wx::PG::PGCell] 
     # @return [void]
     def set_cell(column, cell) end
     
@@ -1405,7 +1453,7 @@ module Wx::PG
     
     # Sets new set of choices for the property.
     # This operation deselects the property and clears its value.
-    # @param choices [Wx::PGChoices] 
+    # @param choices [Wx::PG::PGChoices] 
     # @return [true,false]
     def set_choices(choices) end
     alias_method :choices=, :set_choices
@@ -1462,7 +1510,8 @@ module Wx::PG
     alias_method :help_string=, :set_help_string
     
     # Sets property's label.
-    # - Properties under same parent may have same labels. However, property names must still remain unique.- Unlike {Wx::PG::PropertyGridInterface#set_property_label}, this does not automatically update the display.
+    # - Properties under same parent may have same labels. However, property names must still remain unique.
+    # - Unlike {Wx::PG::PropertyGridInterface#set_property_label}, this does not automatically update the display.
     # @param label [String] 
     # @return [void]
     def set_label(label) end
@@ -1609,7 +1658,7 @@ module Wx::PG
     # @overload initialize()
     #   Default constructor.
     #   It is protected because {Wx::PG::PGProperty} is only a base class for other property classes.
-    #   @return [PGProperty]
+    #   @return [Wx::PG::PGProperty]
     # @overload initialize(label, name)
     #   Constructor.
     #   It is protected because {Wx::PG::PGProperty} is only a base class for other property classes. Non-abstract property classes should have constructor of this style:
@@ -1633,7 +1682,7 @@ module Wx::PG
     #   ```
     #   @param label [String] 
     #   @param name [String] 
-    #   @return [PGProperty]
+    #   @return [Wx::PG::PGProperty]
     def initialize(*args) end
     
   end # PGProperty
@@ -1653,17 +1702,17 @@ module Wx::PG
   
     # @overload initialize()
     #   Default constructor.
-    #   @return [PGChoices]
+    #   @return [Wx::PG::PGChoices]
     # @overload initialize(a)
     #   Copy constructor, uses reference counting.
     #   To create a real copy, use {Wx::PG::PGChoices#copy} member function instead.
-    #   @param a [Wx::PGChoices] 
-    #   @return [PGChoices]
+    #   @param a [Wx::PG::PGChoices] 
+    #   @return [Wx::PG::PGChoices]
     # @overload initialize(labels, values=(Wx::ArrayInt.new()))
     #   Constructor.
     #   @param labels [Array<String>]  Labels for choices.
     #   @param values [Array<Integer>]  Values for choices. If empty, indexes are used. Otherwise must have at least the same size as labels.
-    #   @return [PGChoices]
+    #   @return [Wx::PG::PGChoices]
     def initialize(*args) end
     
     # @overload add(arr, arrint)
@@ -1675,28 +1724,28 @@ module Wx::PG
     #   Adds a single choice item.
     #   @param label [String]  Label for added choice.
     #   @param value [Integer]  Value for added choice. If unspecified, index is used.
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     # @overload add(label, bitmap, value=Wx::PG::PG_INVALID_VALUE)
     #   Adds a single item, with bitmap.
     #   @param label [String] 
     #   @param bitmap [Wx::Bitmap] 
     #   @param value [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     # @overload add(entry)
     #   Adds a single item with full entry information.
-    #   @param entry [Wx::PGChoiceEntry] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @param entry [Wx::PG::PGChoiceEntry] 
+    #   @return [Wx::PG::PGChoiceEntry]
     def add(*args) end
     
     # Adds a single item, sorted.
     # @param label [String] 
     # @param value [Integer] 
-    # @return [Wx::PGChoiceEntry]
+    # @return [Wx::PG::PGChoiceEntry]
     def add_as_sorted(label, value=Wx::PG::PG_INVALID_VALUE) end
     
     # Assigns choices data, using reference counting.
     # To create a real copy, use {Wx::PG::PGChoices#copy} member function instead.
-    # @param a [Wx::PGChoices] 
+    # @param a [Wx::PG::PGChoices] 
     # @return [void]
     def assign(a) end
     
@@ -1705,7 +1754,7 @@ module Wx::PG
     def clear; end
     
     # Returns a real copy of the choices.
-    # @return [Wx::PGChoices]
+    # @return [Wx::PG::PGChoices]
     def copy; end
     
     # @return [void]
@@ -1763,12 +1812,12 @@ module Wx::PG
     #   @param label [String] 
     #   @param index [Integer] 
     #   @param value [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     # @overload insert(entry, index)
     #   Inserts a single item with full entry information.
-    #   @param entry [Wx::PGChoiceEntry] 
+    #   @param entry [Wx::PG::PGChoiceEntry] 
     #   @param index [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     def insert(*args) end
     
     # Returns false if this is a constant empty set of choices, which should not be modified.
@@ -1779,11 +1828,11 @@ module Wx::PG
     # @overload item(i)
     #   Returns item at given index.
     #   @param i [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     # @overload item(i)
     #   Returns item at given index.
     #   @param i [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     def item(*args) end
     
     # Removes count items starting at position nIndex.
@@ -1809,10 +1858,10 @@ module Wx::PG
     
     # @overload [](i)
     #   @param i [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     # @overload [](i)
     #   @param i [Integer] 
-    #   @return [Wx::PGChoiceEntry]
+    #   @return [Wx::PG::PGChoiceEntry]
     def [](*args) end
     
   end # PGChoices
@@ -1827,12 +1876,12 @@ module Wx::PG
     # {Wx::PG::PropertyGrid}
     # 
     # 
-    # @return [Wx::PropertyGrid]
+    # @return [Wx::PG::PropertyGrid]
     def parent; end
     # {Wx::PG::PropertyGrid}
     # 
     # 
-    # @param val [Wx::PropertyGrid]
+    # @param val [Wx::PG::PropertyGrid]
     # @return [void]
     def parent=(val); end
     

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

@@ -124,7 +124,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 ({Wx::MSW} 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)
     

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

@@ -22,9 +22,9 @@ module Wx::PG
   # 
   # === 
   # 
-  # Category:  {Wx::PG::PropertyGrid}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
-  #   </td><td> {Wx::GTK} Appearance
-  #   </td><td> {Wx::OSX} 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>
   # 
   class PropertyGrid < ScrolledControl
@@ -34,7 +34,7 @@ module Wx::PG
     # 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).
     # @see Wx::PG::PropertyGrid#do_hide_property_error 
-    # @param property [Wx::PGProperty] 
+    # @param property [Wx::PG::PGProperty] 
     # @param msg [String] 
     # @return [void]
     def do_show_property_error(property, msg) end
@@ -42,7 +42,7 @@ 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::PGProperty] 
+    # @param property [Wx::PG::PGProperty] 
     # @return [void]
     def do_hide_property_error(property) end
     
@@ -54,14 +54,14 @@ module Wx::PG
     
     # 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::PGProperty]  Property with entered an invalid value
+    # @param property [Wx::PG::PGProperty]  Property with entered an invalid value
     # @param invalidValue [Wx::Variant]  Value which failed in validation.
     # @return [true,false]
     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.
-    # @param property [Wx::PGProperty] 
+    # @param property [Wx::PG::PGProperty] 
     # @return [void]
     def do_on_validation_failure_reset(property) end
     
@@ -108,7 +108,7 @@ module Wx::PG
     # @overload initialize()
     #   Two step constructor.
     #   Call {Wx::PG::PropertyGrid#create} when this constructor is called to build up the {Wx::PG::PropertyGrid}
-    #   @return [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)
     #   Constructor.
     #   The styles to be used are styles valid for the {Wx::Window}.
@@ -119,7 +119,7 @@ module Wx::PG
     #   @param size [Array(Integer, Integer), Wx::Size] 
     #   @param style [Integer] 
     #   @param name [String] 
-    #   @return [PropertyGrid]
+    #   @return [Wx::PG::PropertyGrid]
     def initialize(*args) end
     
     # Adds given key combination to trigger given action.
@@ -290,19 +290,19 @@ module Wx::PG
     
     # Returns pointer to itself.
     # Dummy function that enables same kind of code to use {Wx::PG::PropertyGrid} and {Wx::PG::PropertyGridManager}.
-    # @return [Wx::PropertyGrid]
+    # @return [Wx::PG::PropertyGrid]
     def get_grid; end
     alias_method :grid, :get_grid
     
     # Returns rectangle of custom paint image.
-    # @param property [Wx::PGProperty]  Return image rectangle for this property.
+    # @param property [Wx::PG::PGProperty]  Return image rectangle for this property.
     # @param item [Integer]  Which choice of property to use (each choice may have different image).
     # @return [Wx::Rect]
     def get_image_rect(property, item) end
     alias_method :image_rect, :get_image_rect
     
     # Returns size of the custom paint image in front of property.
-    # @param property [Wx::PGProperty]  Return image rectangle for this property. If this argument is NULL, then preferred size is returned.
+    # @param property [Wx::PG::PGProperty]  Return image rectangle for this property. If this argument is NULL, then preferred size is returned.
     # @param item [Integer]  Which choice of property to use (each choice may have different image).
     # @return [Wx::Size]
     def get_image_size(property=nil, item=-1) end
@@ -375,7 +375,7 @@ module Wx::PG
     # Returns current appearance of unspecified value cells.
     # 
     # @see Wx::PG::PropertyGrid#set_unspecified_value_appearance 
-    # @return [Wx::PGCell]
+    # @return [Wx::PG::PGCell]
     def get_unspecified_value_appearance; end
     alias_method :unspecified_value_appearance, :get_unspecified_value_appearance
     
@@ -392,7 +392,7 @@ module Wx::PG
     
     # Returns information about arbitrary position in the grid.
     # @param pt [Array(Integer, Integer), Wx::Point]  Coordinates in the virtual grid space. You may need to use Wx::Scrolled<T>#calc_scrolled_position for translating {Wx::PG::PropertyGrid} client coordinates into something this member function can use.
-    # @return [Wx::PropertyGridHitTestResult]
+    # @return [Wx::PG::PropertyGridHitTestResult]
     def hit_test(pt) end
     
     # Returns true if any property has been modified by the user.
@@ -436,7 +436,7 @@ module Wx::PG
     def refresh_editor; end
     
     # Redraws given property.
-    # @param p [Wx::PGProperty] 
+    # @param p [Wx::PG::PGProperty] 
     # @return [void]
     def refresh_property(p) end
     
@@ -570,7 +570,7 @@ module Wx::PG
     # If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.
     # @see Wx::PG::PGProperty#set_value_to_unspecified
     # @see  Wx::PG::PGProperty#is_value_unspecified 
-    # @param cell [Wx::PGCell] 
+    # @param cell [Wx::PG::PGCell] 
     # @return [void]
     def set_unspecified_value_appearance(cell) end
     alias_method :unspecified_value_appearance=, :set_unspecified_value_appearance
@@ -599,7 +599,7 @@ module Wx::PG
     def unfocus_editor; end
     
     # Draws item, children, and consecutive parents as long as category is not met.
-    # @param p [Wx::PGProperty] 
+    # @param p [Wx::PG::PGProperty] 
     # @return [void]
     def draw_item_and_value_related(p) end
     
@@ -611,9 +611,9 @@ module Wx::PG
     
     # Registers a new editor class.
     # Returns pointer to the editor class instance that should be used.
-    # @param editor [Wx::PGEditor] 
+    # @param editor [Wx::PG::PGEditor] 
     # @param name [String] 
-    # @return [Wx::PGEditor]
+    # @return [Wx::PG::PGEditor]
     def self.do_register_editor_class(editor, name) end
     
   end # PropertyGrid