wxruby3 0.9.2-x64-mingw-ucrt → 0.9.4-x64-mingw-ucrt

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

@@ -641,6 +641,7 @@ module Wx
   NULL_FONT = nil
   
   # A font is an object which determines the appearance of text.
+  # 
   # Fonts are used for drawing text to a device context, and setting the appearance of a window's text, see {Wx::DC#set_font} and {Wx::Window#set_font}.
   # The easiest way to create a custom font is to use {Wx::FontInfo} object to specify the font attributes and then use wxFont::wxFont(const wxFontInfo&) constructor. Alternatively, you could start with one of the pre-defined fonts or use {Wx::Window#get_font} and modify the font, e.g. by increasing its size using {Wx::Font#make_larger} or changing its weight using {Wx::Font#make_bold}.
   # This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.
@@ -666,6 +667,7 @@ module Wx
     alias_method :base_font, :get_base_font
     
     # Returns the encoding of this font.
+    # 
     # Note that under WXGTK the returned value is always {Wx::FontEncoding::FONTENCODING_UTF8}.
     # @see Wx::Font#set_encoding 
     # @return [Wx::FontEncoding]
@@ -674,12 +676,14 @@ module Wx
     
     # Returns the face name associated with the font, or the empty string if there is no face information.
     # 
+    # 
     # @see Wx::Font#set_face_name 
     # @return [String]
     def get_face_name; end
     alias_method :face_name, :get_face_name
     
     # Gets the font family if possible.
+    # 
     # As described in {Wx::FontFamily} docs the returned value acts as a rough, basic classification of the main font properties (look, spacing).
     # If the current font face name is not recognized by {Wx::Font} or by the underlying system, {Wx::FontFamily::FONTFAMILY_DEFAULT} is returned.
     # Note that currently this function is not very precise and so not particularly useful. Font families mostly make sense only for font creation, see {Wx::Font#set_family}.
@@ -689,6 +693,7 @@ module Wx
     alias_method :family, :get_family
     
     # Returns the platform-dependent string completely describing this font.
+    # 
     # Returned string is always non-empty unless the font is invalid (in which case an assert is triggered).
     # Note that the returned string is not meant to be shown or edited by the user: a typical use of this function is for serializing in string-form a {Wx::Font} object.
     # @see Wx::Font#set_native_font_info
@@ -698,6 +703,7 @@ module Wx
     alias_method :native_font_info_desc, :get_native_font_info_desc
     
     # Returns a user-friendly string for this font object.
+    # 
     # Returned string is always non-empty unless the font is invalid (in which case an assert is triggered).
     # The string does not encode all {Wx::Font} infos under all platforms; e.g. under WXMSW the font family is not present in the returned string.
     # Some examples of the formats of returned strings (which are platform-dependent) are in {Wx::Font#set_native_font_info_user_desc}.
@@ -708,6 +714,7 @@ module Wx
     alias_method :native_font_info_user_desc, :get_native_font_info_user_desc
     
     # Gets the point size as an integer number.
+    # 
     # This function is kept for compatibility reasons. New code should use {Wx::Font#get_fractional_point_size} and support fractional point sizes.
     # @see Wx::Font#set_point_size
     # @see  
@@ -719,12 +726,14 @@ module Wx
     
     # Gets the point size as a floating number.
     # 
+    # 
     # @see SetPointSize(float)
     # @return [Float]
     def get_fractional_point_size; end
     alias_method :fractional_point_size, :get_fractional_point_size
     
     # Gets the pixel size.
+    # 
     # Note that under WXMSW if you passed to {Wx::Font#set_pixel_size} (or to the ctor) a {Wx::Size} object with a null width value, you'll get a null width in the returned object.
     # @see Wx::Font#set_pixel_size 
     # @return [Wx::Size]
@@ -732,6 +741,7 @@ module Wx
     alias_method :pixel_size, :get_pixel_size
     
     # Gets the font style.
+    # 
     # See {Wx::FontStyle} for a list of valid styles.
     # @see Wx::Font#set_style 
     # @return [Wx::FontStyle]
@@ -740,17 +750,20 @@ module Wx
     
     # Returns true if the font is underlined, false otherwise.
     # 
+    # 
     # @see Wx::Font#set_underlined 
     # @return [Boolean]
     def get_underlined; end
     
     # Returns true if the font is stricken-through, false otherwise.
     # 
+    # 
     # @see Wx::Font#set_strikethrough
     # @return [Boolean]
     def get_strikethrough; end
     
     # Gets the font weight.
+    # 
     # See {Wx::FontWeight} for a list of valid weight identifiers.
     # @see Wx::Font#set_weight 
     # @return [Wx::FontWeight]
@@ -758,6 +771,7 @@ module Wx
     alias_method :weight, :get_weight
     
     # Gets the font weight as an integer value.
+    # 
     # See {Wx::FontWeight} for a list of valid weight identifiers and their corresponding integer value.
     # @see Wx::Font#set_weight 
     # 
@@ -767,6 +781,7 @@ module Wx
     alias_method :numeric_weight, :get_numeric_weight
     
     # Returns true if the font is a fixed width (or monospaced) font, false if it is a proportional one or font is invalid.
+    # 
     # Note that this function under some platforms is different from just testing for the font family being equal to {Wx::FontFamily::FONTFAMILY_TELETYPE} because native platform-specific functions are used for the check (resulting in a more accurate return value).
     # @return [Boolean]
     def is_fixed_width; end
@@ -778,6 +793,7 @@ module Wx
     alias_method :ok?, :is_ok
     
     # Specify the name of a file containing a TrueType font to be made available to the current application.
+    # 
     # This method can be used to allow this application to use the font from the given file even if it is not globally installed on the system.
     # Under macOS this method actually doesn't do anything other than check for the existence of the file in the "Fonts" subdirectory of the application bundle "Resources" directory. You are responsible for actually making the font file available in this directory and setting ATSApplicationFontsPath to Fonts value in your Info.plist file. See also {Wx::StandardPaths#get_resources_dir}.
     # Under MSW this method must be called before any {Wx::GraphicsContext} objects have been created, otherwise the private font won't be usable from them.
@@ -790,17 +806,20 @@ module Wx
     
     # Returns a bold version of this font.
     # 
+    # 
     # @see Wx::Font#make_bold
     # @return [Wx::Font]
     def bold; end
     
     # Returns an italic version of this font.
     # 
+    # 
     # @see Wx::Font#make_italic
     # @return [Wx::Font]
     def italic; end
     
     # Returns a larger version of this font.
+    # 
     # The font size is multiplied by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.
     # @see Wx::Font#make_larger
     # @see  Wx::Font#smaller
@@ -809,6 +828,7 @@ module Wx
     def larger; end
     
     # Returns a smaller version of this font.
+    # 
     # The font size is divided by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.
     # @see Wx::Font#make_smaller
     # @see  Wx::Font#larger
@@ -818,11 +838,13 @@ module Wx
     
     # Returns underlined version of this font.
     # 
+    # 
     # @see Wx::Font#make_underlined
     # @return [Wx::Font]
     def underlined; end
     
     # Returns stricken-through version of this font.
+    # 
     # Currently stricken-through fonts are only supported in WXMSW, WXGTK, and WXOSX.
     # @see Wx::Font#make_strikethrough
     # @return [Wx::Font]
@@ -830,17 +852,20 @@ module Wx
     
     # Changes this font to be bold.
     # 
+    # 
     # @see Wx::Font#bold
     # @return [Wx::Font]
     def make_bold; end
     
     # Changes this font to be italic.
     # 
+    # 
     # @see Wx::Font#italic
     # @return [Wx::Font]
     def make_italic; end
     
     # Changes this font to be larger.
+    # 
     # The font size is multiplied by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.
     # @see Wx::Font#larger
     # @see  Wx::Font#make_smaller
@@ -849,6 +874,7 @@ module Wx
     def make_larger; end
     
     # Changes this font to be smaller.
+    # 
     # The font size is divided by 1.2, the factor of 1.2 being inspired by the W3C CSS specification.
     # @see Wx::Font#smaller
     # @see  Wx::Font#make_larger
@@ -858,17 +884,20 @@ module Wx
     
     # Changes this font to be underlined.
     # 
+    # 
     # @see Wx::Font#underlined
     # @return [Wx::Font]
     def make_underlined; end
     
     # Changes this font to be stricken-through.
+    # 
     # Currently stricken-through fonts are only supported in WXMSW, WXGTK, and WXOSX.
     # @see Wx::Font#strikethrough
     # @return [Wx::Font]
     def make_strikethrough; end
     
     # Changes the size of this font.
+    # 
     # The font size is multiplied by the given factor (which may be less than 1 to create a smaller version of the font).
     # @see Wx::Font#scaled
     # @see  Wx::Font#make_larger
@@ -878,6 +907,7 @@ module Wx
     def scale(x) end
     
     # Returns a scaled version of this font.
+    # 
     # The font size is multiplied by the given factor (which may be less than 1 to create a smaller version of the font).
     # @see Wx::Font#scale
     # @see  Wx::Font#larger
@@ -887,6 +917,7 @@ module Wx
     def scaled(x) end
     
     # Sets the encoding for this font.
+    # 
     # Note that under WXGTK this function has no effect (because the underlying Pango library always uses {Wx::FontEncoding::FONTENCODING_UTF8}).
     # @see Wx::Font#get_encoding 
     # @param encoding [Wx::FontEncoding] 
@@ -895,11 +926,12 @@ module Wx
     alias_method :encoding=, :set_encoding
     
     # Sets the facename for the font.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>To avoid portability problems, don't rely on a specific face, but specify the font family instead (see {Wx::FontFamily} and {Wx::Font#set_family}).
     # </p>
-    # </div>>
+    # </div>
     # 
     # true if the given face name exists; if the face name doesn't exist in the user's system then the font is invalidated (so that {Wx::Font#is_ok} will return false) and false is returned.
     # @see Wx::Font#get_face_name
@@ -910,6 +942,7 @@ module Wx
     alias_method :face_name=, :set_face_name
     
     # Sets the font family.
+    # 
     # As described in {Wx::FontFamily} docs the given family value acts as a rough, basic indication of the main font properties (look, spacing).
     # Note that changing the font family results in changing the font face name.
     # @see Wx::Font#get_family
@@ -920,6 +953,7 @@ module Wx
     alias_method :family=, :set_family
     
     # Creates the font corresponding to the given native font description string which must have been previously returned by {Wx::Font#get_native_font_info_desc}.
+    # 
     # If the string is invalid, font is unchanged. This function is typically used for de-serializing a {Wx::Font} object previously saved in a string-form.
     # true if the creation was successful.
     # @see Wx::Font#set_native_font_info_user_desc 
@@ -929,6 +963,7 @@ module Wx
     alias_method :native_font_info=, :set_native_font_info
     
     # Creates the font corresponding to the given native font description string and returns true if the creation was successful.
+    # 
     # Unlike {Wx::Font#set_native_font_info}, this function accepts strings which are user-friendly. Examples of accepted string formats are:
     # 
     # platform 
@@ -954,6 +989,7 @@ module Wx
     alias_method :native_font_info_user_desc=, :set_native_font_info_user_desc
     
     # Sets the font size in points to an integer value.
+    # 
     # This is a legacy version of the function only supporting integer point sizes. It can still be used, but to avoid unnecessarily restricting the font size in points to integer values, consider using the new (added in wxWidgets 3.1.2) {Wx::Font#set_fractional_point_size} function instead.
     # @param pointSize [Integer] 
     # @return [void]
@@ -961,6 +997,7 @@ module Wx
     alias_method :point_size=, :set_point_size
     
     # Sets the font size in points.
+    # 
     # The point size is defined as 1/72 of the Anglo-Saxon inch (25.4 mm): it is approximately 0.0139 inch or 352.8 um.
     # @see Wx::Font#get_fractional_point_size
     # @see  Wx::Font#set_point_size
@@ -970,6 +1007,7 @@ module Wx
     alias_method :fractional_point_size=, :set_fractional_point_size
     
     # Sets the pixel size.
+    # 
     # The height parameter of pixelSize must be positive while the width parameter may also be zero (to indicate that you're not interested in the width of the characters: a suitable width will be chosen for best rendering).
     # This feature (specifying the font pixel size) is directly supported only under WXMSW and WXGTK currently; under other platforms a font with the closest size to the given one is found using binary search (this maybe slower).
     # @see Wx::Font#get_pixel_size 
@@ -980,6 +1018,7 @@ module Wx
     
     # Sets the font style.
     # 
+    # 
     # @see Wx::Font#get_style 
     # @param style [Wx::FontStyle]  One of the {Wx::FontStyle} enumeration values.
     # @return [void]
@@ -987,6 +1026,7 @@ module Wx
     alias_method :style=, :set_style
     
     # Sets the font size using a predefined symbolic size name.
+    # 
     # This function allows changing font size to be (very) large or small compared to the standard font size.
     # @see Wx::Font#set_symbolic_size_relative_to.
     # @param size [Wx::FontSymbolicSize] 
@@ -995,6 +1035,7 @@ module Wx
     alias_method :symbolic_size=, :set_symbolic_size
     
     # Sets the font size compared to the base font size.
+    # 
     # This is the same as {Wx::Font#set_symbolic_size} except that it uses the given font size as the normal font size instead of the standard font size.
     # @param size [Wx::FontSymbolicSize] 
     # @param base [Integer] 
@@ -1003,6 +1044,7 @@ module Wx
     
     # Sets underlining.
     # 
+    # 
     # @see Wx::Font#get_underlined 
     # @param underlined [Boolean]  true to underline, false otherwise.
     # @return [void]
@@ -1010,6 +1052,7 @@ module Wx
     alias_method :underlined=, :set_underlined
     
     # Sets strike-through attribute of the font.
+    # 
     # Currently stricken-through fonts are only supported in WXMSW, WXGTK, and WXOSX.
     # @see Wx::Font#get_strikethrough
     # @param strikethrough [Boolean]  true to add strike-through style, false to remove it.
@@ -1019,6 +1062,7 @@ module Wx
     
     # Sets the font weight.
     # 
+    # 
     # @see Wx::Font#get_weight 
     # @param weight [Wx::FontWeight]  One of the {Wx::FontWeight} values.
     # @return [void]
@@ -1026,6 +1070,7 @@ module Wx
     alias_method :weight=, :set_weight
     
     # Sets the font weight using an integer value.
+    # 
     # See {Wx::FontWeight} for a list of valid weight identifiers and their corresponding integer value.
     # @see Wx::Font#get_numeric_weight 
     # @param weight [Integer]  An integer value int the range 1-1000.
@@ -1035,6 +1080,7 @@ module Wx
     
     # @overload self.create(pointSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
+    #   
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pointSize [Integer] 
     #   @param family [Wx::FontFamily] 
@@ -1046,6 +1092,7 @@ module Wx
     #   @return [Wx::Font]
     # @overload self.create(pointSize, family, flags=Wx::FontFlag::FONTFLAG_DEFAULT, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
+    #   
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pointSize [Integer] 
     #   @param family [Wx::FontFamily] 
@@ -1055,6 +1102,7 @@ module Wx
     #   @return [Wx::Font]
     # @overload self.create(pixelSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
+    #   
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pixelSize [Array(Integer, Integer), Wx::Size] 
     #   @param family [Wx::FontFamily] 
@@ -1066,6 +1114,7 @@ module Wx
     #   @return [Wx::Font]
     # @overload self.create(pixelSize, family, flags=Wx::FontFlag::FONTFLAG_DEFAULT, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
+    #   
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param pixelSize [Array(Integer, Integer), Wx::Size] 
     #   @param family [Wx::FontFamily] 
@@ -1075,6 +1124,7 @@ module Wx
     #   @return [Wx::Font]
     # @overload self.create(nativeInfoString)
     #   This function takes the same parameters as the relative wxFont constructor and returns a new font object allocated on the heap.
+    #   
     #   Their use is discouraged, use {Wx::Font} constructor from {Wx::FontInfo} instead.
     #   @param nativeInfoString [String] 
     #   @return [Wx::Font]
@@ -1089,6 +1139,7 @@ module Wx
     #   @return [Wx::Font]
     # @overload initialize(fontInfo)
     #   Creates a font object using the specified font description.
+    #   
     #   This is the preferred way to create font objects as using this ctor results in more readable code and it is also extensible, e.g. it could continue to be used if support for more font attributes is added in the future. For example, this constructor provides the only way of creating fonts with strike-through style.
     #   Example of creating a font using this ctor: 
     #   ```ruby
@@ -1098,6 +1149,7 @@ module Wx
     #   @return [Wx::Font]
     # @overload initialize(pointSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   Creates a font object with the specified attributes and size in points.
+    #   
     #   Notice that the use of this constructor is often more verbose and less readable than using wxFont(const wxFontInfo& font), e.g. the example in that constructor documentation would need to be written as:
     #   
     #   ```ruby
@@ -1110,7 +1162,7 @@ module Wx
     #   <b>Remark:</b>
     #   <p>If the desired font does not exist, the closest match will be chosen. Under Windows, only scalable TrueType fonts are used. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param pointSize [Integer]  Size in points. See {Wx::Font#set_point_size} for more info. Notice that, for historical reasons, the value 70 here is interpreted at {Wx::DEFAULT} and results in creation of the font with the default size and not of a font with the size of 70pt. If you really need the latter, please use SetPointSize(70). Note that this constructor and the matching Create() method overload are the only places in {Wx::Font} API handling {Wx::DEFAULT} specially: neither {Wx::Font#set_point_size} nor the constructor taking {Wx::FontInfo} handle this value in this way.
     #   @param family [Wx::FontFamily]  The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the {Wx::FontFamily} enumeration values. If the faceName argument is provided, then it overrides the font family.
     #   @param style [Wx::FontStyle]  One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
@@ -1121,13 +1173,14 @@ module Wx
     #   @return [Wx::Font]
     # @overload initialize(pixelSize, family, style, weight, underline=false, faceName=(''), encoding=Wx::FontEncoding::FONTENCODING_DEFAULT)
     #   Creates a font object with the specified attributes and size in pixels.
+    #   
     #   Notice that the use of this constructor is often more verbose and less readable than the use of constructor from {Wx::FontInfo}, consider using that constructor instead.
     #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>If the desired font does not exist, the closest match will be chosen. Under Windows, only scalable TrueType fonts are used. 
     #   </p>
-    #   </div>>
+    #   </div>
     #   @param pixelSize [Array(Integer, Integer), Wx::Size]  Size in pixels. See {Wx::Font#set_pixel_size} for more info.
     #   @param family [Wx::FontFamily]  The font family: a generic portable way of referring to fonts without specifying a facename. This parameter must be one of the {Wx::FontFamily} enumeration values. If the faceName argument is provided, then it overrides the font family.
     #   @param style [Wx::FontStyle]  One of {Wx::FontStyle::FONTSTYLE_NORMAL}, {Wx::FontStyle::FONTSTYLE_SLANT} and {Wx::FontStyle::FONTSTYLE_ITALIC}.
@@ -1138,12 +1191,14 @@ module Wx
     #   @return [Wx::Font]
     # @overload initialize(nativeInfoString)
     #   Constructor from font description string.
+    #   
     #   This constructor uses {Wx::Font#set_native_font_info} to initialize the font. If fontdesc is invalid the font remains uninitialized, i.e. its {Wx::Font#is_ok} method will return false.
     #   @param nativeInfoString [String] 
     #   @return [Wx::Font]
     def initialize(*args) end
     
     # Equality operator.
+    # 
     # See reference-counted object comparison for more info.
     # @param font [Wx::Font,Wx::FontInfo] 
     # @return [Boolean]
@@ -1151,6 +1206,7 @@ module Wx
     
     # Returns the current application's default encoding.
     # 
+    # 
     # @see Font Encodings
     # @see  Wx::Font.set_default_encoding 
     # @return [Wx::FontEncoding]
@@ -1158,6 +1214,7 @@ module Wx
     
     # Sets the default font encoding.
     # 
+    # 
     # @see Font Encodings
     # @see  Wx::Font.get_default_encoding 
     # @param encoding [Wx::FontEncoding] 
@@ -1165,6 +1222,7 @@ module Wx
     def self.set_default_encoding(encoding) end
     
     # Get the raw weight value corresponding to the given symbolic constant.
+    # 
     # For compatibility, this function handles the values {Wx::NORMAL}, {Wx::LIGHT} and {Wx::BOLD}, that have values 90, 91 and 92, specially and converts them to the corresponding {Wx::FONTWEIGHT_XXX} weight value.
     # 
     # Numeric weight, between 1 and 1000.
@@ -1175,6 +1233,7 @@ module Wx
   end # Font
   
   # This class is a helper used for {Wx::Font} creation using named parameter idiom: it allows specifying various {Wx::Font} attributes using the chained calls to its clearly named methods instead of passing them in the fixed order to {Wx::Font} constructors.
+  # 
   # For example, to create an italic font with the given face name and size you could use: 
   # ```ruby
   #   font = Wx::Font.new(Wx::FontInfo.new(12).face_name('Helvetica').italic())
@@ -1192,6 +1251,7 @@ module Wx
     #   @return [Wx::FontInfo]
     # @overload initialize(pointSize)
     #   Constructor setting the font size in points to use.
+    #   
     #   Note that until wxWidgets 3.1.2 fractional point sizes were not supported, and the type of pointSize was int.
     #   @see Wx::Font#set_point_size 
     #   @param pointSize [Float] 
@@ -1199,12 +1259,14 @@ module Wx
     # @overload initialize(pixelSize)
     #   Constructor setting the font size in pixels to use.
     #   
+    #   
     #   @see Wx::Font#set_pixel_size 
     #   @param pixelSize [Array(Integer, Integer), Wx::Size] 
     #   @return [Wx::FontInfo]
     def initialize(*args) end
     
     # Set the font family.
+    # 
     # The family is a generic portable way of referring to fonts without specifying a precise face name. This parameter must be one of the {Wx::FontFamily} enumeration values.
     # If the {Wx::FontInfo#face_name} is used, then it overrides the font family.
     # @see Wx::Font#set_family 
@@ -1213,6 +1275,7 @@ module Wx
     def family(family) end
     
     # Set the font face name to use.
+    # 
     # Face names are not portable, so prefer to use {Wx::FontInfo#family} in portable code.
     # @see Wx::Font#set_face_name 
     # @param faceName [String] 
@@ -1225,6 +1288,7 @@ module Wx
     def weight(weight) end
     
     # Use a bold version of the font.
+    # 
     # This is a wrapper for {Wx::FontInfo#weight} calling it with {Wx::FontWeight::FONTWEIGHT_BOLD} argument.
     # @see Wx::FontWeight
     # @see  Wx::Font#set_weight 
@@ -1233,6 +1297,7 @@ module Wx
     def bold(bold=true) end
     
     # Use a lighter version of the font.
+    # 
     # This is a wrapper for {Wx::FontInfo#weight} calling it with {Wx::FontWeight::FONTWEIGHT_LIGHT} argument.
     # @see Wx::FontWeight
     # @see  Wx::Font#set_weight 
@@ -1241,6 +1306,7 @@ module Wx
     def light(light=true) end
     
     # Use an italic version of the font.
+    # 
     # This is a wrapper for {Wx::FontInfo#style} calling it with {Wx::FontStyle::FONTSTYLE_ITALIC} argument.
     # @see Wx::FontStyle
     # @see  Wx::Font#set_style 
@@ -1249,6 +1315,7 @@ module Wx
     def italic(italic=true) end
     
     # Use a slanted version of the font.
+    # 
     # This is a wrapper for {Wx::FontInfo#style} calling it with {Wx::FontStyle::FONTSTYLE_SLANT} argument.
     # @see Wx::FontStyle
     # @see  Wx::Font#set_style 
@@ -1262,6 +1329,7 @@ module Wx
     def style(style) end
     
     # Set anti-aliasing flag.
+    # 
     # Force the use of anti-aliasing on or off.
     # Currently this is not implemented, i.e. using this method doesn't do anything.
     # @param antiAliased [Boolean] 
@@ -1274,12 +1342,14 @@ module Wx
     def underlined(underlined=true) end
     
     # Use a strike-through version of the font.
+    # 
     # Currently this is only implemented in WXMSW, WXGTK, and WXOSX.
     # @param strikethrough [Boolean] 
     # @return [Wx::FontInfo]
     def strikethrough(strikethrough=true) end
     
     # Set the font encoding to use.
+    # 
     # This is mostly unneeded in Unicode builds of wxWidgets.
     # @see Wx::FontEncoding
     # @see  Wx::Font#set_encoding 
@@ -1288,6 +1358,7 @@ module Wx
     def encoding(encoding) end
     
     # Set all the font attributes at once.
+    # 
     # See {Wx::FontFlag} for the various flags that can be used.
     # Note that calling this method affects the font weight stored in this object: it is set to {Wx::FontWeight::FONTWEIGHT_LIGHT} or {Wx::FontWeight::FONTWEIGHT_BOLD} if the corresponding flag is present in flags, or {Wx::FontWeight::FONTWEIGHT_NORMAL} otherwise.
     # @param flags [Integer] 
@@ -1295,6 +1366,7 @@ module Wx
     def all_flags(flags) end
     
     # Get the symbolic weight closest to the given raw weight value.
+    # 
     # A valid element of {Wx::FontWeight} enum.
     # @param numWeight [Integer]  A valid raw weight value, i.e. a value in the range 1 to 1000, inclusive.
     # @return [Wx::FontWeight]

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

@@ -7,6 +7,7 @@
 module Wx
 
   # This class holds a variety of information related to font dialogs.
+  # 
   # Category:  Common Dialogs, Data Structures
   # @see wxFontDialog Overview
   # @see  Wx::Font
@@ -19,11 +20,13 @@ module Wx
   class FontData < Object
   
     # Constructor.
+    # 
     # Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.
     # @return [Wx::FontData]
     def initialize; end
     
     # Enables or disables "effects" under Windows or generic only.
+    # 
     # This refers to the controls for manipulating colour, strikeout and underline properties.
     # The default value is true.
     # @param enable [Boolean] 
@@ -31,6 +34,7 @@ module Wx
     def enable_effects(enable) end
     
     # Under Windows, returns a flag determining whether symbol fonts can be selected.
+    # 
     # Has no effect on other platforms.
     # The default value is true.
     # @return [Boolean]
@@ -43,18 +47,21 @@ module Wx
     alias_method :chosen_font, :get_chosen_font
     
     # Gets the colour associated with the font dialog.
+    # 
     # The default value is black.
     # @return [Wx::Colour,String,Symbol]
     def get_colour; end
     alias_method :colour, :get_colour
     
     # Determines whether "effects" are enabled under Windows.
+    # 
     # This refers to the controls for manipulating colour, strikeout and underline properties.
     # The default value is true.
     # @return [Boolean]
     def get_enable_effects; end
     
     # Returns the state of the flags restricting the selection.
+    # 
     # Note that currently these flags are only effectively used in WXMSW.
     # 
     # - {Wx::FONTRESTRICT_NONE} If no restriction applies, or a combination of the following flags:
@@ -66,18 +73,21 @@ module Wx
     def get_restrict_selection; end
     
     # Gets the font that will be initially used by the font dialog.
+    # 
     # This should have previously been set by the application.
     # @return [Wx::Font]
     def get_initial_font; end
     alias_method :initial_font, :get_initial_font
     
     # Returns true if the Help button will be shown (Windows only).
+    # 
     # The default value is false.
     # @return [Boolean]
     def get_show_help; end
     alias_method :show_help, :get_show_help
     
     # Restricts the selection to a subset of the available fonts.
+    # 
     # Note that currently these flags are only effectively used in WXMSW and are ignored in the other ports.
     # Possible values are:
     # 
@@ -91,6 +101,7 @@ module Wx
     def restrict_selection(flags) end
     
     # Under Windows, determines whether symbol fonts can be selected.
+    # 
     # Has no effect on other platforms.
     # The default value is true.
     # @param allowSymbols [Boolean] 
@@ -105,6 +116,7 @@ module Wx
     alias_method :chosen_font=, :set_chosen_font
     
     # Sets the colour that will be used for the font foreground colour.
+    # 
     # The default colour is black.
     # @param colour [Wx::Colour,String,Symbol] 
     # @return [void]
@@ -118,6 +130,7 @@ module Wx
     alias_method :initial_font=, :set_initial_font
     
     # Sets the valid range for the font point size (Windows only).
+    # 
     # The default is 0, 0 (unrestricted range).
     # @param min [Integer] 
     # @param max [Integer] 
@@ -125,6 +138,7 @@ module Wx
     def set_range(min, max) end
     
     # Determines whether the Help button will be displayed in the font dialog (Windows only).
+    # 
     # The default value is false.
     # @param showHelp [Boolean] 
     # @return [void]