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

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

@@ -8,7 +8,7 @@ module Wx
 
   # This class represents the events generated by a splitter control.
   # Also there is only one event class, the data associated to the different events is not the same and so not all accessor functions may be called for each event. The documentation mentions the kind of event(s) for which the given accessor function makes sense: calling it for other types of events will result in assert failure (in debug mode) and will return meaningless results.
-  # === Events using this class
+  # ### Events using this class
   # 
   # The following event-handler methods redirect the events to member method or handler blocks for {Wx::SplitterEvent} events.
   # Event handler methods:
@@ -21,18 +21,17 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_splitter_dclick}(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a {Wx::EVT_SPLITTER_DOUBLECLICKED} event. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Events}
   # @see Wx::SplitterWindow
   # @see  Events and Event Handling 
   # 
   # 
+  # @wxrb_require USE_SPLITTER
   class SplitterEvent < NotifyEvent
   
     # Constructor.
     # Used internally by wxWidgets only.
-    # @param eventType [Wx::CommandLinkButton::EventType] 
+    # @param eventType [Wx::Slider::EventType] 
     # @param splitter [Wx::SplitterWindow] 
     # @return [Wx::SplitterEvent]
     def initialize(eventType=Wx::EVT_NULL, splitter=nil) end

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

@@ -40,6 +40,7 @@ module Wx
   # 
   # 
   # 
+  # @wxrb_require USE_SPLITTER
   class SplitMode < Wx::Enum
   
     # 
@@ -86,7 +87,7 @@ module Wx
   
   # This class manages up to two subwindows.
   # The current view can be split into two programmatically (perhaps from a menu command), and unsplit either programmatically or via the {Wx::SplitterWindow} user interface.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -108,7 +109,7 @@ module Wx
   # 
   # - {Wx::SP_LIVE_UPDATE}: Don't draw XOR line but resize the child windows immediately. 
   # 
-  # === 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::SplitterEvent} events.
   # Event handler methods for events emitted by this class:
@@ -123,21 +124,24 @@ module Wx
   # 
   # - {Wx::EvtHandler#evt_splitter_dclick}(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a {Wx::EVT_SPLITTER_DOUBLECLICKED} event. 
   # 
-  # === 
-  # 
   # Category:  Miscellaneous Windows
   # @see Wx::SplitterEvent
   # @see  wxSplitterWindow Overview 
   # 
   # 
+  # @wxrb_require USE_SPLITTER
   class SplitterWindow < Window
   
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::SplitterWindow]
-    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("splitterWindow"))
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("SPLITTER_WINDOW"))
     #   Constructor for creating the window.
-    #   After using this constructor, you must create either one or two subwindows with the splitter window as parent, and then call one of {Wx::SplitterWindow#initialize}, {Wx::SplitterWindow#split_vertically} and {Wx::SplitterWindow#split_horizontally} in order to set the pane(s). You can create two windows, with one hidden when not being shown; or you can create and delete the second pane on demand.
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>After using this constructor, you must create either one or two subwindows with the splitter window as parent, and then call one of {Wx::SplitterWindow#initialize}, {Wx::SplitterWindow#split_vertically} and {Wx::SplitterWindow#split_horizontally} in order to set the pane(s). You can create two windows, with one hidden when not being shown; or you can create and delete the second pane on demand.
+    #   </p>
+    #   </div>>
     #   @see Wx::SplitterWindow#initialize
     #   @see  Wx::SplitterWindow#split_vertically
     #   @see  Wx::SplitterWindow#split_horizontally
@@ -160,7 +164,7 @@ module Wx
     # @param style [Integer] 
     # @param name [String] 
     # @return [Boolean]
-    def create(parent, id=Wx::StandardID::ID_ANY, point=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("splitter")) end
+    def create(parent, id=Wx::StandardID::ID_ANY, point=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("SPLITTER")) end
     
     # Returns the current minimum pane size (defaults to zero).
     # 
@@ -220,7 +224,11 @@ module Wx
     # Initializes the splitter window to have one pane.
     # The child window is shown if it is currently hidden.
     # 
-    # This should be called if you wish to initially view only a single pane in the splitter window.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This should be called if you wish to initially view only a single pane in the splitter window.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#split_vertically
     # @see  Wx::SplitterWindow#split_horizontally 
     # @param window [Wx::Window]  The pane for the unsplit window.
@@ -228,7 +236,11 @@ module Wx
     def init(window) end
     
     # Returns true if the sash is invisible even when the window is split, false otherwise.
-    # This is a shortcut for HasFlag({Wx::SP_NOSASH})
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This is a shortcut for HasFlag({Wx::SP_NOSASH})
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#set_sash_invisible
     # @return [Boolean]
     def is_sash_invisible; end
@@ -240,7 +252,11 @@ module Wx
     alias_method :split?, :is_split
     
     # Application-overridable function called when the sash is double-clicked with the left mouse button.
-    # The default implementation of this function calls Unsplit if the minimum pane size is zero.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The default implementation of this function calls Unsplit if the minimum pane size is zero.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#unsplit 
     # @param x [Integer]  The x position of the mouse cursor.
     # @param y [Integer]  The y position of the mouse cursor.
@@ -250,13 +266,21 @@ module Wx
     # Application-overridable function called when the sash position is changed by user.
     # It may return false to prevent the change or true to allow it.
     # 
-    # The default implementation of this function verifies that the sizes of both panes of the splitter are greater than minimum pane size.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The default implementation of this function verifies that the sizes of both panes of the splitter are greater than minimum pane size. 
+    # </p>
+    # </div>>
     # @param newSashPosition [Integer]  The new sash position (always positive or zero)
     # @return [Boolean]
     def on_sash_position_change(newSashPosition) end
     
     # Application-overridable function called when the window is unsplit, either programmatically or using the {Wx::SplitterWindow} user interface.
-    # The default implementation of this function simply hides removed. You may wish to delete the window.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The default implementation of this function simply hides removed. You may wish to delete the window. 
+    # </p>
+    # </div>>
     # @param removed [Wx::Window]  The window being removed.
     # @return [void]
     def on_unsplit(removed) end
@@ -271,7 +295,11 @@ module Wx
     def replace_window(winOld, winNew) end
     
     # Sets the minimum pane size.
-    # The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging), set a minimum size, for example 20 pixels. If the {Wx::SP_PERMIT_UNSPLIT} style is used when a splitter window is created, the window may be unsplit even if minimum size is non-zero.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging), set a minimum size, for example 20 pixels. If the {Wx::SP_PERMIT_UNSPLIT} style is used when a splitter window is created, the window may be unsplit even if minimum size is non-zero.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#get_minimum_pane_size 
     # @param paneSize [Integer]  Minimum pane size in pixels.
     # @return [void]
@@ -279,12 +307,17 @@ module Wx
     alias_method :minimum_pane_size=, :set_minimum_pane_size
     
     # Sets the sash gravity.
-    # Gravity is real factor which controls position of sash while resizing {Wx::SplitterWindow}. Gravity tells {Wx::SplitterWindow} how much will left/top window grow while resizing. Example values:
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Gravity is real factor which controls position of sash while resizing {Wx::SplitterWindow}. Gravity tells {Wx::SplitterWindow} how much will left/top window grow while resizing. Example values:
     # 
     # - 0.0: only the bottom/right window is automatically resized
     # - 0.5: both windows grow by equal size
     # - 1.0: only left/top window grows Gravity should be a real value between 0.0 and 1.0. Default value of sash gravity is 0.0. That value is compatible with previous (before gravity was introduced) behaviour of {Wx::SplitterWindow}.
     # 
+    # </p>
+    # </div>>
+    # 
     # Notice that when sash gravity for a newly created splitter window, it is often necessary to explicitly set the splitter size using {Wx::SplitterWindow#set_size} to ensure that is big enough for its initial sash position. Otherwise, i.e. if the window is created with the default tiny size and only resized to its correct size later, the initial sash position will be affected by the gravity and typically result in sash being at the rightmost position for the gravity of 1. See the example code creating {Wx::SplitterWindow} in the splitter sample for more details.
     # @see Wx::SplitterWindow#get_sash_gravity 
     # @param gravity [Float]  The sash gravity. Value between 0.0 and 1.0.
@@ -293,7 +326,11 @@ module Wx
     alias_method :sash_gravity=, :set_sash_gravity
     
     # Sets the sash position.
-    # Does not currently check for an out-of-range value.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Does not currently check for an out-of-range value.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#get_sash_position 
     # @param position [Integer]  The sash position in pixels.
     #   
@@ -306,7 +343,11 @@ module Wx
     alias_method :sash_position=, :set_sash_position
     
     # Sets the split mode.
-    # Only sets the internal variable; does not update the display.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Only sets the internal variable; does not update the display.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#get_split_mode
     # @see  Wx::SplitterWindow#split_vertically
     # @see  Wx::SplitterWindow#split_horizontally. 
@@ -317,7 +358,12 @@ module Wx
     
     # Sets whether the sash should be invisible, even when the window is split.
     # When the sash is invisible, it doesn't appear on the screen at all and, in particular, doesn't allow the user to resize the windows.
-    # Only sets the internal variable; does not update the display.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Only sets the internal variable; does not update the display.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#is_sash_invisible
     # @param invisible [Boolean]  If true, the sash is always invisible, else it is shown when the window is split.
     # @return [void]
@@ -329,7 +375,11 @@ module Wx
     # 
     # true if successful, false otherwise (the window was already split).
     # 
-    # This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using {Wx::SplitterWindow#is_split}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using {Wx::SplitterWindow#is_split}.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#split_vertically
     # @see  Wx::SplitterWindow#is_split
     # @see  Wx::SplitterWindow#unsplit 
@@ -344,7 +394,11 @@ module Wx
     # 
     # true if successful, false otherwise (the window was already split).
     # 
-    # This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using {Wx::SplitterWindow#is_split}.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using {Wx::SplitterWindow#is_split}.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#split_horizontally
     # @see  Wx::SplitterWindow#is_split
     # @see  Wx::SplitterWindow#unsplit. 
@@ -357,7 +411,11 @@ module Wx
     # Unsplits the window.
     # true if successful, false otherwise (the window was not split).
     # 
-    # This call will not actually delete the pane being removed; it calls {Wx::SplitterWindow#on_unsplit} which can be overridden for the desired behaviour. By default, the pane being removed is hidden.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This call will not actually delete the pane being removed; it calls {Wx::SplitterWindow#on_unsplit} which can be overridden for the desired behaviour. By default, the pane being removed is hidden.
+    # </p>
+    # </div>>
     # @see Wx::SplitterWindow#split_horizontally
     # @see  Wx::SplitterWindow#split_vertically
     # @see  Wx::SplitterWindow#is_split

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

@@ -10,15 +10,15 @@ module Wx
   # Native implementations on some platforms are only meant for display of the small icons in the dialog boxes.
   # If you want to display larger images portably, you may use generic implementation {Wx::GenericStaticBitmap} declared in <wx/generic/statbmpg.h>.
   # Notice that for the best results, the size of the control should be the same as the size of the image displayed in it, as happens by default if it's not resized explicitly. Otherwise, behaviour depends on the platform: under MSW, the bitmap is drawn centred inside the control, while elsewhere it is drawn at the origin of the control. You can use {Wx::StaticBitmap#set_scale_mode} to control how the image is scaled inside the control.
-  # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <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>
   # @see Wx::Bitmap 
   # 
   # 
+  # @wxrb_require USE_STATBMP
   class StaticBitmap < Control
   
     # Specify how the bitmap should be scaled in the control.
@@ -28,6 +28,7 @@ module Wx
     # @see  Wx::StaticBitmap#get_scale_mode 
     # 
     # 
+    # @wxrb_require USE_STATBMP
     class ScaleMode < Wx::Enum
     
       # The bitmap is displayed in original size.
@@ -51,7 +52,7 @@ module Wx
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::StaticBitmap]
-    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBitmapNameStr)
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BITMAP_NAME_STR)
     #   Constructor, creating and showing a static bitmap control.
     #   
     #   @see Wx::StaticBitmap#create 
@@ -75,7 +76,7 @@ module Wx
     # @param style [Integer] 
     # @param name [String] 
     # @return [Boolean]
-    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBitmapNameStr) end
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BITMAP_NAME_STR) end
     
     # Returns the bitmap currently used in the control.
     # Notice that this method can be called even if {Wx::StaticBitmap#set_icon} had been used.
@@ -106,7 +107,11 @@ module Wx
     alias_method :icon=, :set_icon
     
     # Sets the scale mode.
-    # Currently only the generic implementation supports all scaling modes. You may use generic implementation {Wx::GenericStaticBitmap} declared in <wx/generic/statbmpg.h> in all ports.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Currently only the generic implementation supports all scaling modes. You may use generic implementation {Wx::GenericStaticBitmap} declared in <wx/generic/statbmpg.h> in all ports.
+    # </p>
+    # </div>
     # @see Wx::StaticBitmap#get_scale_mode
     # @param scaleMode [Wx::wxStaticBitmap::ScaleMode]  Controls how the bitmap is scaled inside the control.
     # @return [void]

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

@@ -25,22 +25,22 @@ module Wx
   # 
   # Creating the windows with the static box parent (i.e. panel in the example above) as parent still works but can result in refresh and repaint problems.
   # Also note that there is a specialized {Wx::Sizer} class ({Wx::StaticBoxSizer}) which can be used as an easier way to pack items into a static box.
-  # === 
   # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <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>
   # @see Wx::StaticText
   # @see  Wx::StaticBoxSizer 
   # 
   # 
+  # @wxrb_require USE_STATBOX
   class StaticBox < Control
   
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::StaticBox]
-    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBoxNameStr)
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
     #   Constructor, creating and showing a static box.
     #   
     #   @see Wx::StaticBox#create 
@@ -49,10 +49,10 @@ module Wx
     #   @param label [String]  Text to be displayed in the static box, the empty string for no label.
     #   @param pos [Array(Integer, Integer), Wx::Point]  Window position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
     #   @param size [Array(Integer, Integer), Wx::Size]  Checkbox size. If {Wx::DEFAULT_SIZE} is specified then a default size is chosen.
-    #   @param style [Integer]  Window style. There are no {Wx::StaticBox}-specific styles, but generic {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE_HORIZONTAL} and {Wx::Alignment::ALIGN_RIGHT} can be used here to change the position of the static box label when using wxGTK (these styles are ignored under the other platforms currently).
+    #   @param style [Integer]  Window style. There are no {Wx::StaticBox}-specific styles, but generic {Wx::Alignment::ALIGN_LEFT}, {Wx::Alignment::ALIGN_CENTRE_HORIZONTAL} and {Wx::Alignment::ALIGN_RIGHT} can be used here to change the position of the static box label when using WXGTK (these styles are ignored under the other platforms currently).
     #   @param name [String]  Window name.
     #   @return [Wx::StaticBox]
-    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBoxNameStr)
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
     #   Constructor for a static box using the given window as label.
     #   This constructor takes a pointer to an arbitrary window (although usually a {Wx::CheckBox} or a {Wx::RadioButton}) instead of just the usual text label and puts this window at the top of the box at the place where the label would be shown.
     #   The label window must be a non-null, fully created window and will become a child of this {Wx::StaticBox}, i.e. it will be owned by this control and will be deleted when the {Wx::StaticBox} itself is deleted.
@@ -70,7 +70,7 @@ module Wx
     #     end
     #   ```
     #   
-    #   Currently this constructor is only available in wxGTK and wxMSW, use {Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX} to check whether it can be used at compile-time.
+    #   Currently this constructor is only available in WXGTK and WXMSW.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param label [Wx::Window] 
@@ -79,9 +79,10 @@ module Wx
     #   @param style [Integer] 
     #   @param name [String] 
     #   @return [Wx::StaticBox]
+    #   @wxrb_require WXMSW|WXGTK
     def initialize(*args) end
     
-    # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBoxNameStr)
+    # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
     #   Creates the static box for two-step construction.
     #   See {Wx::StaticBox#initialize} for further details.
     #   @param parent [Wx::Window] 
@@ -92,11 +93,11 @@ module Wx
     #   @param style [Integer] 
     #   @param name [String] 
     #   @return [Boolean]
-    # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticBoxNameStr)
+    # @overload create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_BOX_NAME_STR)
     #   Creates the static box with the window as a label.
     #   This method can only be called for an object created using its default constructor.
     #   See the constructor documentation for more details.
-    #   Currently this overload is only available in wxGTK and wxMSW, use {Wx::HAS_WINDOW_LABEL_IN_STATIC_BOX} to check whether it can be used at compile-time.
+    #   Currently this overload is only available in WXGTK and WXMSW.
     #   @param parent [Wx::Window] 
     #   @param id [Integer] 
     #   @param label [Wx::Window] 
@@ -105,6 +106,7 @@ module Wx
     #   @param style [Integer] 
     #   @param name [String] 
     #   @return [Boolean]
+    #   @wxrb_require WXMSW|WXGTK
     def create(*args) end
     
     # Enables or disables the box without affecting its label window, if any.

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

@@ -25,8 +25,6 @@ module Wx
   #   end
   # ```
   # 
-  # === 
-  # 
   # Category:  Window Layout
   # @see Wx::Sizer
   # @see  Wx::StaticBox

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

@@ -7,8 +7,8 @@
 module Wx
 
   # A static line is just a line which may be used in a dialog to separate the groups of controls.
-  # The line may be only vertical or horizontal. Moreover, not all ports (notably not wxGTK) support specifying the transversal direction of the line (e.g. height for a horizontal line) so for maximal portability you should specify it as {Wx::DEFAULT_COORD}.
-  # === Styles
+  # The line may be only vertical or horizontal. Moreover, not all ports (notably not WXGTK) support specifying the transversal direction of the line (e.g. height for a horizontal line) so for maximal portability you should specify it as {Wx::DEFAULT_COORD}.
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -16,18 +16,17 @@ module Wx
   # 
   # - {Wx::LI_VERTICAL}: Creates a vertical line. 
   # 
-  # === 
-  # 
   # Category:  {Wx::Controls}
   # @see Wx::StaticBox 
   # 
   # 
+  # @wxrb_require USE_STATLINE
   class StaticLine < Control
   
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::StaticLine]
-    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LI_HORIZONTAL, name=Wx::StaticLineNameStr)
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LI_HORIZONTAL, name=Wx::STATIC_LINE_NAME_STR)
     #   Constructor, creating and showing a static line.
     #   
     #   @see Wx::StaticLine#create 
@@ -49,7 +48,7 @@ module Wx
     # @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::LI_HORIZONTAL, name=Wx::StaticLineNameStr) end
+    def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::LI_HORIZONTAL, name=Wx::STATIC_LINE_NAME_STR) end
     
     # Returns true if the line is vertical, false if horizontal.
     # @return [Boolean]

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

@@ -20,7 +20,7 @@ module Wx
   
   # A static text control displays one or more lines of read-only text.
   # {Wx::StaticText} supports the three classic text alignments, label ellipsization i.e. replacing parts of the text with the ellipsis ("...") if the label doesn't fit into the provided space and also formatting markup with {Wx::Control#set_label_markup}.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
@@ -38,22 +38,21 @@ module Wx
   # 
   # - {Wx::ST_ELLIPSIZE_END}: If the label text width exceeds the control width, replace the end of the label with an ellipsis; uses {Wx::Control.ellipsize}. 
   # 
-  # === 
-  # 
-  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> wxMSW Appearance
-  #   </td><td> wxGTK Appearance
-  #   </td><td> wxOSX Appearance
+  # Category:  {Wx::Controls}  <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>
   # @see Wx::StaticBitmap
   # @see  Wx::StaticBox 
   # 
   # 
+  # @wxrb_require USE_STATTEXT
   class StaticText < Control
   
     # @overload initialize()
     #   Default constructor.
     #   @return [Wx::StaticText]
-    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticTextNameStr)
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_TEXT_NAME_STR)
     #   Constructor, creating and showing a text control.
     #   
     #   @see Wx::StaticText#create 
@@ -77,7 +76,7 @@ module Wx
     # @param style [Integer] 
     # @param name [String] 
     # @return [Boolean]
-    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::StaticTextNameStr) end
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::STATIC_TEXT_NAME_STR) end
     
     # Returns true if the window styles for this control contains one of the {Wx::ST_ELLIPSIZE_START}, {Wx::ST_ELLIPSIZE_MIDDLE} or {Wx::ST_ELLIPSIZE_END} styles.
     # @return [Boolean]

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

@@ -40,13 +40,13 @@ module Wx
   # It can contain one or more fields, one or more of which can be variable length according to the size of the window.
   # {Wx::StatusBar} also maintains an independent stack of status texts for each field (see {Wx::StatusBar#push_status_text} and {Wx::StatusBar#pop_status_text}).
   # Note that in {Wx::StatusBar} context, the terms pane and field are synonyms.
-  # === Styles
+  # ### Styles
   # 
   # This class supports the following styles:
   # 
   # - {Wx::STB_SIZEGRIP}: Displays a gripper at the right-hand side of the status bar which can be used to resize the parent window. 
   # 
-  # - {Wx::STB_SHOW_TIPS}: Displays tooltips for those panes whose status text has been ellipsized/truncated because the status text doesn't fit the pane width. Note that this style has effect only on wxGTK (with GTK+ >= 2.12) currently. 
+  # - {Wx::STB_SHOW_TIPS}: Displays tooltips for those panes whose status text has been ellipsized/truncated because the status text doesn't fit the pane width. Note that this style has effect only on WXGTK (with GTK+ >= 2.12) currently. 
   # 
   # - {Wx::STB_ELLIPSIZE_START}: Replace the beginning of the status texts with an ellipsis when the status text widths exceed the status bar pane's widths (uses {Wx::Control.ellipsize}). 
   # 
@@ -56,11 +56,17 @@ module Wx
   # 
   # - {Wx::STB_DEFAULT_STYLE}: The default style: includes <code>wxSTB_SIZEGRIP|wxSTB_SHOW_TIPS|wxSTB_ELLIPSIZE_END|wxFULL_REPAINT_ON_RESIZE</code>. 
   # 
-  # It is possible to create controls and other windows on the status bar. Position these windows from an OnSize() event handler.
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>It is possible to create controls and other windows on the status bar. Position these windows from an OnSize() event handler.
+  # </p>
+  # </div>>
   # 
-  # Notice that only the first 127 characters of a string will be shown in status bar fields under Windows if a proper manifest indicating that the program uses version 6 of common controls library is not used. This is a limitation of the native control on these platforms.
-  # 
-  # === 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>Notice that only the first 127 characters of a string will be shown in status bar fields under Windows if a proper manifest indicating that the program uses version 6 of common controls library is not used. This is a limitation of the native control on these platforms.
+  # </p>
+  # </div>>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::StatusBarPane
@@ -68,12 +74,13 @@ module Wx
   # @see  Status Bar Sample 
   # 
   # 
+  # @wxrb_require USE_STATUSBAR
   class StatusBar < Control
   
     # @overload initialize()
     #   Default ctor.
     #   @return [Wx::StatusBar]
-    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, style=Wx::STB_DEFAULT_STYLE, name=Wx::StatusBarNameStr)
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, style=Wx::STB_DEFAULT_STYLE, name=Wx::STATUS_BAR_NAME_STR)
     #   Constructor, creating the window.
     #   
     #   @see Wx::StatusBar#create 
@@ -91,7 +98,7 @@ module Wx
     # @param style [Integer] 
     # @param name [String] 
     # @return [Boolean]
-    def create(parent, id=Wx::StandardID::ID_ANY, style=Wx::STB_DEFAULT_STYLE, name=Wx::StatusBarNameStr) end
+    def create(parent, id=Wx::StandardID::ID_ANY, style=Wx::STB_DEFAULT_STYLE, name=Wx::STATUS_BAR_NAME_STR) end
     
     # Returns the size and position of a field's internal bounding rectangle.
     # true if the field index is valid, false otherwise.
@@ -194,7 +201,11 @@ module Wx
     # There are two types of fields: <b>fixed</b> widths and <b>variable</b> width fields. For the fixed width fields you should specify their (constant) width in pixels. For the variable width fields, specify a negative number which indicates how the field should expand: the space left for all variable width fields is divided between them according to the absolute value of this number. A variable width field with width of -2 gets twice as much of it as a field with width -1 and so on.
     # For example, to create one fixed width field of width 100 in the right part of the status bar and two more fields which get 66% and 33% of the remaining space correspondingly, you should use an array containing -2, -1 and 100.
     # 
-    # The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
+    # </p>
+    # </div>>
     # @see Wx::StatusBar#set_fields_count
     # @see  Wx::Frame#set_status_widths 
     # @param widths_field [Array<Integer>]  Contains an array of n integers, each of which is either an absolute status field width in pixels if positive or indicates a variable width field if negative. The special value NULL means that all fields should get the same width.
@@ -204,14 +215,13 @@ module Wx
   end # StatusBar
   
   # A status bar pane data container used by {Wx::StatusBar}.
-  # === 
-  # 
   # Category:  Data Structures
   # @see Wx::StatusBar 
   # 
   # 
   # 
   # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_STATUSBAR
   class StatusBarPane < ::Object
   
     # Constructs the pane with the given style and width.