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

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

@@ -37,6 +37,7 @@ module Wx
   SB_SUNKEN = 3
   
   # A status bar is a narrow window that can be placed along the bottom of a frame to give small amounts of status information.
+  # 
   # 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.
@@ -60,13 +61,13 @@ module Wx
   # <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>>
+  # </div>
   # 
   # <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>>
+  # </div>
   # 
   # Category:  Miscellaneous Windows
   # @see Wx::StatusBarPane
@@ -83,6 +84,7 @@ module Wx
     # @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 
     #   @param parent [Wx::Window]  The window parent, usually a frame.
     #   @param id [Integer]  The window identifier. It may take a value of -1 to indicate a default value.
@@ -92,6 +94,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the window, for two-step construction.
+    # 
     # See {Wx::StatusBar#initialize} for details.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -101,6 +104,7 @@ module Wx
     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.
     # @see Wx::Rect 
     # @param i [Integer]  The field in question.
@@ -120,12 +124,14 @@ module Wx
     alias_method :field, :get_field
     
     # Returns the horizontal and vertical borders used when rendering the field text inside the field area.
+    # 
     # Note that the rect returned by {Wx::StatusBar#get_field_rect} already accounts for the presence of horizontal and vertical border returned by this function.
     # @return [Wx::Size]
     def get_borders; end
     alias_method :borders, :get_borders
     
     # Returns the string associated with a status bar field.
+    # 
     # The status field string if the field is valid, otherwise the empty string.
     # @see Wx::StatusBar#set_status_text 
     # @param i [Integer]  The number of the status field to retrieve, starting from zero.
@@ -134,6 +140,7 @@ module Wx
     alias_method :status_text, :get_status_text
     
     # Returns the width of the n-th field.
+    # 
     # See {Wx::StatusBarPane#get_width} for more info.
     # @param n [Integer] 
     # @return [Integer]
@@ -141,6 +148,7 @@ module Wx
     alias_method :status_width, :get_status_width
     
     # Returns the style of the n-th field.
+    # 
     # See {Wx::StatusBarPane#get_style} for more info.
     # @param n [Integer] 
     # @return [Integer]
@@ -148,6 +156,7 @@ module Wx
     alias_method :status_style, :get_status_style
     
     # Restores the text to the value it had before the last call to {Wx::StatusBar#push_status_text}.
+    # 
     # Notice that if {Wx::StatusBar#set_status_text} had been called in the meanwhile, {Wx::StatusBar#pop_status_text} will not change the text, i.e. it does not override explicit changes to status text but only restores the saved text if it hadn't been changed since.
     # @see Wx::StatusBar#push_status_text 
     # @param field [Integer] 
@@ -156,6 +165,7 @@ module Wx
     
     # Saves the current field text in a per-field stack, and sets the field text to the string passed as argument.
     # 
+    # 
     # @see Wx::StatusBar#pop_status_text 
     # @param string [String] 
     # @param field [Integer] 
@@ -170,6 +180,7 @@ module Wx
     alias_method :fields_count=, :set_fields_count
     
     # Sets the minimal possible height for the status bar.
+    # 
     # The real height may be bigger than the height specified here depending on the size of the font used by the status bar.
     # @param height [Integer] 
     # @return [void]
@@ -187,6 +198,7 @@ module Wx
     def set_status_styles(styles) end
     
     # Sets the status text for the i-th field.
+    # 
     # The given text will replace the current text. The display of the status bar is updated immediately, so there is no need to call {Wx::Window#update} after calling this function.
     # Note that if {Wx::StatusBar#push_status_text} had been called before the new text will also replace the last saved value to make sure that the next call to {Wx::StatusBar#pop_status_text} doesn't restore the old value, which was overwritten by the call to this function.
     # @see Wx::StatusBar#get_status_text
@@ -198,6 +210,7 @@ module Wx
     alias_method :status_text=, :set_status_text
     
     # Sets the widths of the fields in the status line.
+    # 
     # 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.
     # 
@@ -205,7 +218,7 @@ module Wx
     # <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>>
+    # </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.
@@ -215,6 +228,7 @@ module Wx
   end # StatusBar
   
   # A status bar pane data container used by {Wx::StatusBar}.
+  # 
   # Category:  Data Structures
   # @see Wx::StatusBar 
   #