wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -7,6 +7,7 @@
 module Wx::PG
 
   # {Wx::PG::PropertyGridManager} is an efficient multi-page version of {Wx::PG::PropertyGrid}, which can optionally have toolbar for mode and page selection, a help text box, and a header.
+  # 
   # {Wx::PG::PropertyGridManager} inherits from {Wx::PG::PropertyGridInterface}, and as such it has most property manipulation functions. However, only some of them affect properties on all pages (e.g. {Wx::PG::PropertyGridManager#get_property_by_name} and {Wx::PG::PropertyGridManager#expand_all}), while some (e.g. {Wx::PG::PropertyGridManager#append}) only apply to the currently selected page.
   # To operate explicitly on properties on specific page, use {Wx::PG::PropertyGridManager#get_page} to obtain pointer to page's {Wx::PG::PropertyGridPage} object.
   # Visual methods, such as SetCellBackgroundColour() are only available in {Wx::PG::PropertyGrid}. Use {Wx::PG::PropertyGridManager#get_grid} to obtain pointer to it.
@@ -47,27 +48,29 @@ module Wx::PG
   #   pgMan.show_header
   # ```
   # 
-  # == Window Styles
+  # ## Window Styles
   # 
   # See wxPropertyGrid Window Styles.
   # 
-  # == Event Handling
+  # ## Event Handling
   # 
   # See wxPropertyGrid Event Handling for more information.
-  # === 
   # 
   # Category:  {Wx::PG::PropertyGrid}
   # 
+  # @wxrb_require USE_PROPGRID
   class PropertyGridManager < Panel
   
     include Wx::PG::PropertyGridInterface
   
     # @overload initialize()
     #   Two step constructor.
+    #   
     #   Call Create when this constructor is called to build up the {Wx::PG::PropertyGridManager}.
     #   @return [Wx::PG::PropertyGridManager]
     # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PGMAN_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_MANAGER_NAME_STR)
     #   The default constructor.
+    #   
     #   The styles to be used are styles valid for the {Wx::Window}.
     #   @see wxPropertyGrid Window Styles 
     #   @param parent [Wx::Window] 
@@ -80,11 +83,16 @@ module Wx::PG
     def initialize(*args) end
     
     # Creates new property page.
+    # 
     # Note that the first page is not created automatically.
     # 
     # Returns pointer to created property grid page.
     # 
-    # If toolbar is used, it is highly recommended that the pages are added when the toolbar is not turned off using window style flag switching. Otherwise toolbar buttons might not be added properly.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If toolbar is used, it is highly recommended that the pages are added when the toolbar is not turned off using window style flag switching. Otherwise toolbar buttons might not be added properly. 
+    # </p>
+    # </div>
     # @param label [String]  A label for the page. This may be shown as a toolbar tooltip etc.
     # @param bmp [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap bundle for toolbar image. If the bundle is empty, then a built-in default bitmap bundle is used.
     # @param pageObj [Wx::PG::PropertyGridPage]  {Wx::PG::PropertyGridPage} instance. Manager will take ownership of this object. NULL indicates that a default page instance should be created.
@@ -101,12 +109,14 @@ module Wx::PG
     def clear_page(page) end
     
     # Forces updating the value of property from the editor control.
+    # 
     # Returns true if value was actually updated.
     # @param flags [Integer] 
     # @return [Boolean]
     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] 
@@ -119,18 +129,25 @@ module Wx::PG
     def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PGMAN_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_MANAGER_NAME_STR) end
     
     # Enables or disables (shows/hides) categories according to parameter enable.
-    # Calling this may not properly update toolbar buttons.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Calling this may not properly update toolbar buttons. 
+    # </p>
+    # </div>
     # @param enable [Boolean] 
     # @return [Boolean]
     def enable_categories(enable) end
     
     # Selects page, 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
     
     # Returns number of columns on given page.
+    # 
     # By the default, returns number of columns on current page.
     # @param page [Integer] 
     # @return [Integer]
@@ -143,6 +160,7 @@ module Wx::PG
     alias_method :desc_box_height, :get_desc_box_height
     
     # Returns pointer to the contained {Wx::PG::PropertyGrid}.
+    # 
     # This does not change after {Wx::PG::PropertyGridManager} has been created, so you can safely obtain pointer once and use it for the entire lifetime of the manager instance.
     # @return [Wx::PG::PropertyGrid]
     def get_grid; end
@@ -165,6 +183,7 @@ module Wx::PG
     alias_method :page, :get_page
     
     # Returns index for a page name.
+    # 
     # If no match is found, {Wx::NOT_FOUND} is returned.
     # @param name [String] 
     # @return [Integer]
@@ -172,6 +191,7 @@ module Wx::PG
     alias_method :page_by_name, :get_page_by_name
     
     # Returns index for a relevant propertygrid state.
+    # 
     # If no match is found, {Wx::NOT_FOUND} is returned.
     # @param pstate [Wx::PG::PropertyGridPageState] 
     # @return [Integer]
@@ -190,6 +210,7 @@ module Wx::PG
     alias_method :page_name, :get_page_name
     
     # Returns "root property" of the given page.
+    # 
     # It does not have name, etc. and it is not visible. It is only useful for accessing its children.
     # @param index [Integer] 
     # @return [Wx::PG::PGProperty]
@@ -217,6 +238,7 @@ module Wx::PG
     alias_method :tool_bar, :get_tool_bar
     
     # Creates new property page.
+    # 
     # Note that the first page is not created automatically.
     # 
     # Returns pointer to created page.
@@ -239,6 +261,7 @@ module Wx::PG
     alias_method :page_modified?, :is_page_modified
     
     # Returns true if property is selected.
+    # 
     # Since selection is page based, this function checks every page in the manager.
     # @param id [String,Wx::PG::PGProperty] 
     # @return [Boolean]
@@ -246,6 +269,7 @@ module Wx::PG
     alias_method :property_selected?, :is_property_selected
     
     # Removes a page.
+    # 
     # Returns false if it was not possible to remove page in question.
     # @param page [Integer] 
     # @return [Boolean]
@@ -267,6 +291,7 @@ module Wx::PG
     
     # Select a property.
     # 
+    # 
     # @see Wx::PG::PropertyGrid#select_property
     # @see  Wx::PG::PropertyGridInterface#clear_selection 
     # @param id [String,Wx::PG::PGProperty] 
@@ -275,7 +300,12 @@ module Wx::PG
     def select_property(id, focus=false) end
     
     # Sets number of columns on given page (default is current page).
-    # If you use header, then you should always use this member function to set the column count, instead of ones present in {Wx::PG::PropertyGrid} or {Wx::PG::PropertyGridPage}.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If you use header, then you should always use this member function to set the column count, instead of ones present in {Wx::PG::PropertyGrid} or {Wx::PG::PropertyGridPage}. 
+    # </p>
+    # </div>
     # @param colCount [Integer] 
     # @param page [Integer] 
     # @return [void]
@@ -283,8 +313,14 @@ module Wx::PG
     alias_method :column_count=, :set_column_count
     
     # Sets a column title.
+    # 
     # Default title for column 0 is "Property", and "Value" for column 1.
-    # If header is not shown yet, then calling this member function will make it visible.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If header is not shown yet, then calling this member function will make it visible. 
+    # </p>
+    # </div>
     # @param idx [Integer] 
     # @param title [String] 
     # @return [void]
@@ -318,7 +354,12 @@ module Wx::PG
     alias_method :page_splitter_left=, :set_page_splitter_left
     
     # Sets splitter position on individual page.
-    # If you use header, then you should always use this member function to set the splitter position, instead of ones present in {Wx::PG::PropertyGrid} or {Wx::PG::PropertyGridPage}.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>If you use header, then you should always use this member function to set the splitter position, instead of ones present in {Wx::PG::PropertyGrid} or {Wx::PG::PropertyGridPage}. 
+    # </p>
+    # </div>
     # @param page [Integer] 
     # @param pos [Integer] 
     # @param column [Integer] 
@@ -326,7 +367,12 @@ module Wx::PG
     def set_page_splitter_position(page, pos, column=0) end
     
     # Sets splitter position for all pages.
-    # 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>
     # 
     # If you use header, then you should always use this member function to set the splitter position, instead of ones present in {Wx::PG::PropertyGrid} or {Wx::PG::PropertyGridPage}.
     # @param pos [Integer] 
@@ -336,8 +382,14 @@ module Wx::PG
     alias_method :splitter_position=, :set_splitter_position
     
     # Show or hide the property grid header control.
+    # 
     # It is hidden by the default.
-    # Grid may look better if you use {Wx::PG::PG_WINDOW_STYLES::PG_NO_INTERNAL_BORDER} window style when showing a header.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Grid may look better if you use {Wx::PG::PG_WINDOW_STYLES::PG_NO_INTERNAL_BORDER} window style when showing a header. 
+    # </p>
+    # </div>
     # @param show [Boolean] 
     # @return [void]
     def show_header(show=true) end

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

@@ -8,10 +8,11 @@ module Wx::PG
 
   # 
   # 
-  # == wxPropertyGridIterator Flags
+  # ## wxPropertyGridIterator Flags
   # 
   # NOTES: At lower 16-bits, there are flags to check if item will be included. At higher 16-bits, there are same flags, but to instead check if children will be included.
   # 
+  # @wxrb_require USE_PROPGRID
   class PG_ITERATOR_FLAGS < Wx::Enum
   
     # Iterate through 'normal' property items (does not include children of aggregate or hidden items by default).
@@ -69,18 +70,19 @@ module Wx::PG
   end # PG_ITERATOR_FLAGS
   
   # Holder of property grid page information.
+  # 
   # You can subclass this and give instance in {Wx::PG::PropertyGridManager#add_page}. It inherits from {Wx::EvtHandler} and can be used to process events specific to this page (id of events will still be same as manager's). If you don't want to use it to process all events of the page, you need to return false in the derived {Wx::PG::PropertyGridPage#is_handling_all_events}.
   # Please note that {Wx::PG::PropertyGridPage} lacks many non-const property manipulation functions found in {Wx::PG::PropertyGridManager}. Please use parent manager (m_manager member variable) when needed.
   # 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.
   # 
-  # == Event Handling
+  # ## Event Handling
   # 
   # {Wx::PG::PropertyGridPage} receives events emitted by its {Wx::PG::PropertyGridManager}, but only those events that are specific to that page. If {Wx::PG::PropertyGridPage}:: IsHandlingAllEvents returns false, then unhandled events are sent to the manager's parent, as usual.
   # See wxPropertyGrid Event Handling for more information.
-  # === 
   # 
   # Category:  {Wx::PG::PropertyGrid}
   # 
+  # @wxrb_require USE_PROPGRID
   class PropertyGridPage < EvtHandler
   
     include Wx::PG::PropertyGridInterface
@@ -93,9 +95,14 @@ module Wx::PG
     def clear; end
     
     # Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).
+    # 
     # Returns minimum size for the page to still display everything.
     # 
-    # This function only works properly if size of containing grid was already fairly large.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This function only works properly if size of containing grid was already fairly large.
+    # </p>
+    # </div>
     # 
     # Note that you can also get calculated column widths by calling {Wx::PG::PropertyGridPage#get_column_width} immediately after this function returns.
     # @return [Wx::Size]
@@ -107,6 +114,7 @@ module Wx::PG
     alias_method :index, :get_index
     
     # 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
@@ -124,9 +132,15 @@ module Wx::PG
     alias_method :tool_id, :get_tool_id
     
     # Do any member initialization in this method.
-    # - Called every time the page is added into a manager.
     # 
-    # - You can add properties to the page here.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>- Called every time the page is added into a manager.
+    # 
+    # - You can add properties to the page here. 
+    # 
+    # </p>
+    # </div>
     # @return [void]
     def init; end
     
@@ -136,6 +150,7 @@ module Wx::PG
     alias_method :handling_all_events?, :is_handling_all_events
     
     # Called every time page is about to be shown.
+    # 
     # Useful, for instance, creating properties just-in-time.
     # @return [void]
     def on_show; end
@@ -146,7 +161,12 @@ module Wx::PG
     def refresh_property(p) end
     
     # Sets splitter position on page.
-    # 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 splitterPos [Integer] 
     # @param col [Integer] 
     # @return [void]
@@ -184,7 +204,12 @@ module Wx::PG
     alias_method :virtual_height, :get_virtual_height
     
     # Returns actual height of contained visible properties.
-    # Mostly used for internal diagnostic purposes.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Mostly used for internal diagnostic purposes. 
+    # </p>
+    # </div>
     # @return [Integer]
     def get_actual_virtual_height; end
     alias_method :actual_virtual_height, :get_actual_virtual_height

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

@@ -7,13 +7,18 @@
 module Wx::PG
 
   # Contains low-level property page information (properties, column widths, etc.) of a single {Wx::PG::PropertyGrid} or single {Wx::PG::PropertyGridPage}.
+  # 
   # Generally you should not use this class directly, but instead member functions in {Wx::PG::PropertyGridInterface}, {Wx::PG::PropertyGrid}, {Wx::PG::PropertyGridPage}, and {Wx::PG::PropertyGridManager}.
-  # Currently this class is not implemented in {Wx::Python}.
   # 
-  # === 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>Currently this class is not implemented in {Wx::Python}.
+  # </p>
+  # </div>
   # 
   # Category:  {Wx::PG::PropertyGrid}
   # 
+  # @wxrb_require USE_PROPGRID
   class PropertyGridPageState < ::Object
   
     # Default constructor.
@@ -39,7 +44,12 @@ module Wx::PG
     alias_method :virtual_height, :get_virtual_height
     
     # Returns actual height of contained visible properties.
-    # Mostly used for internal diagnostic purposes.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Mostly used for internal diagnostic purposes. 
+    # </p>
+    # </div>
     # @return [Integer]
     def get_actual_virtual_height; end
     alias_method :actual_virtual_height, :get_actual_virtual_height
@@ -109,24 +119,28 @@ module Wx::PG
   end # PropertyGridPageState
   
   # 
-  # == wxPropertyGridHitTestResult
+  # 
+  # ## wxPropertyGridHitTestResult
   # 
   # A return value from {Wx::PG::PropertyGrid#hit_test}, contains all you need to know about an arbitrary location on the grid.
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_PROPGRID
   class PropertyGridHitTestResult < ::Object
   
     # @return [Wx::PG::PropertyGridHitTestResult]
     def initialize; end
     
     # Returns column hit.
+    # 
     # -1 for margin.
     # @return [Integer]
     def get_column; end
     alias_method :column, :get_column
     
     # Returns property hit.
+    # 
     # NULL if empty space below properties was hit instead.
     # @return [Wx::PG::PGProperty]
     def get_property; end

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

@@ -13,16 +13,15 @@ module Wx
   PB_SMALL = 32768
   
   # Base abstract class for all pickers which support an auxiliary text control.
+  # 
   # This class handles all positioning and sizing of the text control like a a horizontal {Wx::BoxSizer} would do, with the text control on the left of the picker button.
   # The proportion (see {Wx::Sizer} documentation for more info about proportion values) of the picker control defaults to 1 when there isn't a text control associated (see {Wx::PB_USE_TEXTCTRL} style) and to 0 otherwise.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
   # - {Wx::PB_USE_TEXTCTRL}: Creates a text control to the left of the picker which is completely managed by this {Wx::PickerBase} class. 
   # 
-  # === 
-  # 
   # Category:  Picker Controls
   # @see Wx::ColourPickerCtrl 
   # 
@@ -33,6 +32,7 @@ module Wx
     def initialize; end
     
     # Returns the margin (in pixel) between the picker and the text control.
+    # 
     # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true.
     # @return [Integer]
     def get_internal_margin; end
@@ -44,13 +44,21 @@ module Wx
     alias_method :picker_ctrl_proportion, :get_picker_ctrl_proportion
     
     # Returns a pointer to the text control handled by this window or NULL if the {Wx::PB_USE_TEXTCTRL} style was not specified when this control was created.
-    # The contents of the text control could be an invalid representation of the entity which can be chosen through the picker (e.g. when the user enters an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. {Wx::ColourPickerCtrl#get_colour}, {Wx::FilePickerCtrl#get_path}, etc).
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The contents of the text control could be an invalid representation of the entity which can be chosen through the picker (e.g. when the user enters an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. {Wx::ColourPickerCtrl#get_colour}, {Wx::FilePickerCtrl#get_path}, etc). 
+    # </p>
+    # </div>
     # @return [Wx::TextCtrl]
     def get_text_ctrl; end
     alias_method :text_ctrl, :get_text_ctrl
     
     # Returns the native implementation of the real picker control.
-    # The returned control in the generic implementation of {Wx::FilePickerCtrl}, {Wx::DirPickerCtrl}, {Wx::FontPickerCtrl} and {Wx::ColourPickerCtrl} is a specialized {Wx::Button} class so that you can change its label doing, e.g.: 
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>The returned control in the generic implementation of {Wx::FilePickerCtrl}, {Wx::DirPickerCtrl}, {Wx::FontPickerCtrl} and {Wx::ColourPickerCtrl} is a specialized {Wx::Button} class so that you can change its label doing, e.g.: 
     # ```ruby
     #   if Wx::PLATFORM == 'WXMSW'
     #     # wxMSW is one of the platforms where the generic implementation
@@ -62,11 +70,15 @@ module Wx
     #     end
     #   end
     # ```
+    #  
+    # </p>
+    # </div>
     # @return [Wx::Control]
     def get_picker_ctrl; end
     alias_method :picker_ctrl, :get_picker_ctrl
     
     # Returns the proportion value of the text control.
+    # 
     # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true.
     # @return [Integer]
     def get_text_ctrl_proportion; end
@@ -83,12 +95,14 @@ module Wx
     alias_method :picker_ctrl_growable?, :is_picker_ctrl_growable
     
     # Returns true if the text control is growable.
+    # 
     # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true.
     # @return [Boolean]
     def is_text_ctrl_growable; end
     alias_method :text_ctrl_growable?, :is_text_ctrl_growable
     
     # Sets the margin (in pixel) between the picker and the text control.
+    # 
     # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true.
     # @param margin [Integer] 
     # @return [void]
@@ -102,6 +116,7 @@ module Wx
     alias_method :picker_ctrl_growable=, :set_picker_ctrl_growable
     
     # Sets the proportion value of the picker.
+    # 
     # Look at the detailed description of {Wx::PickerBase} for more info.
     # @param prop [Integer] 
     # @return [void]
@@ -109,6 +124,7 @@ module Wx
     alias_method :picker_ctrl_proportion=, :set_picker_ctrl_proportion
     
     # Sets the text control as growable when grow is true.
+    # 
     # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true.
     # @param grow [Boolean] 
     # @return [void]
@@ -116,6 +132,7 @@ module Wx
     alias_method :text_ctrl_growable=, :set_text_ctrl_growable
     
     # Sets the proportion value of the text control.
+    # 
     # Look at the detailed description of {Wx::PickerBase} for more info.
     # This function can be used only when {Wx::PickerBase#has_text_ctrl} returns true.
     # @param prop [Integer]