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

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

@@ -7,6 +7,7 @@
 module Wx
 
   # {Wx::TextAttr} represents the character and paragraph attributes, or style, for a range of text in a {Wx::TextCtrl} or {Wx::RTC::RichTextCtrl}.
+  # 
   # When setting up a {Wx::TextAttr} object, pass a bitlist mask to {Wx::TextAttr#set_flags} to indicate which style elements should be changed. As a convenience, when you call a setter such as SetFont, the relevant bit will be set.
   # 
   # Category:  Rich Text
@@ -35,6 +36,7 @@ module Wx
     def initialize(*args) end
     
     # Returns the alignment flags.
+    # 
     # See {Wx::TextAttrAlignment} for a list of available styles.
     # @return [Wx::TextAttrAlignment]
     def get_alignment; end
@@ -46,12 +48,14 @@ module Wx
     alias_method :background_colour, :get_background_colour
     
     # Returns a string containing the name of the font associated with the bullet symbol.
+    # 
     # Only valid for attributes with {Wx::TEXT_ATTR_BULLET_SYMBOL}.
     # @return [Wx::String]
     def get_bullet_font; end
     alias_method :bullet_font, :get_bullet_font
     
     # Returns the standard bullet name, applicable if the bullet style is {Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD}.
+    # 
     # Currently the following standard bullet names are supported:
     # 
     # - <code>standard/circle</code> 
@@ -74,6 +78,7 @@ module Wx
     alias_method :bullet_number, :get_bullet_number
     
     # Returns the bullet style.
+    # 
     # See {Wx::TextAttrBulletStyle} for a list of available styles.
     # @return [Integer]
     def get_bullet_style; end
@@ -90,12 +95,14 @@ module Wx
     alias_method :character_style_name, :get_character_style_name
     
     # Returns flags indicating which attributes are applicable.
+    # 
     # See {Wx::TextAttr#set_flags} for a list of available flags.
     # @return [Integer]
     def get_flags; end
     alias_method :flags, :get_flags
     
     # Creates and returns a font specified by the font attributes in the {Wx::TextAttr} object.
+    # 
     # Note that {Wx::TextAttr} does not store a {Wx::Font} object, so this is only a temporary font.
     # For greater efficiency, access the font attributes directly.
     # @return [Wx::Font]
@@ -145,6 +152,7 @@ module Wx
     alias_method :underline_type, :get_underline_type
     
     # Returns the underline color used.
+    # 
     # {Wx::NULL_COLOUR} when the text colour is used.
     # @return [Wx::Colour,String,Symbol]
     def get_underline_colour; end
@@ -201,6 +209,7 @@ module Wx
     alias_method :right_indent, :get_right_indent
     
     # Returns an array of tab stops, each expressed in tenths of a millimeter.
+    # 
     # Each stop is measured from the left margin and therefore each value must be larger than the last.
     # @return [Wx::ArrayInt]
     def get_tabs; end
@@ -212,18 +221,21 @@ module Wx
     alias_method :text_colour, :get_text_colour
     
     # Returns the text effect bits of interest.
+    # 
     # See {Wx::TextAttr#set_flags} for further information.
     # @return [Integer]
     def get_text_effect_flags; end
     alias_method :text_effect_flags, :get_text_effect_flags
     
     # Returns the text effects, a bit list of styles.
+    # 
     # See {Wx::TextAttr#set_text_effects} for details.
     # @return [Integer]
     def get_text_effects; end
     alias_method :text_effects, :get_text_effects
     
     # Returns the URL for the content.
+    # 
     # Content with {Wx::TextAttrFlags::TEXT_ATTR_URL} style causes {Wx::RTC::RichTextCtrl} to show a hand cursor over it, and {Wx::RTC::RichTextCtrl} generates a {Wx::TextUrlEvent} when the content is clicked.
     # @return [Wx::String]
     def get_url; end
@@ -401,6 +413,7 @@ module Wx
     alias_method :paragraph_style?, :is_paragraph_style
     
     # Sets the paragraph alignment.
+    # 
     # See {Wx::TextAttrAlignment} enumeration values.
     # Of these, {Wx::TextAttrAlignment::TEXT_ALIGNMENT_JUSTIFIED} is unimplemented. In future justification may be supported when printing or previewing, only.
     # @param alignment [Wx::TextAttrAlignment] 
@@ -415,6 +428,7 @@ module Wx
     alias_method :background_colour=, :set_background_colour
     
     # Sets the name of the font associated with the bullet symbol.
+    # 
     # Only valid for attributes with {Wx::TEXT_ATTR_BULLET_SYMBOL}.
     # @param font [String] 
     # @return [void]
@@ -422,6 +436,7 @@ module Wx
     alias_method :bullet_font=, :set_bullet_font
     
     # Sets the standard bullet name, applicable if the bullet style is {Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_STANDARD}.
+    # 
     # See {Wx::TextAttr#get_bullet_name} for a list of supported names, and how to expand the range of supported types.
     # @param name [String] 
     # @return [void]
@@ -435,6 +450,7 @@ module Wx
     alias_method :bullet_number=, :set_bullet_number
     
     # Sets the bullet style.
+    # 
     # The {Wx::TextAttrBulletStyle} enumeration values are all supported, except for {Wx::TextAttrBulletStyle::TEXT_ATTR_BULLET_STYLE_BITMAP}.
     # @param style [Integer] 
     # @return [void]
@@ -454,6 +470,7 @@ module Wx
     alias_method :character_style_name=, :set_character_style_name
     
     # Sets the flags determining which styles are being specified.
+    # 
     # The {Wx::TextAttrFlags} values can be passed in a bitlist.
     # @param flags [Integer] 
     # @return [void]
@@ -461,6 +478,7 @@ module Wx
     alias_method :flags=, :set_flags
     
     # Sets the attributes for the given font.
+    # 
     # Note that {Wx::TextAttr} does not store an actual {Wx::Font} object.
     # @param font [Wx::Font,Wx::FontInfo] 
     # @param flags [Integer] 
@@ -516,6 +534,7 @@ module Wx
     #   @return [void]
     # @overload set_font_underlined(type, colour=Wx::NULL_COLOUR)
     #   Sets the font underlining.
+    #   
     #   <div class="wxrb-note">
     #   <b>Note:</b>
     #   <p>On WXMSW, {Wx::TextAttrUnderlineType::TEXT_ATTR_UNDERLINE_DOUBLE} is shown as {Wx::TextAttrUnderlineType::TEXT_ATTR_UNDERLINE_SOLID}. There is only a limited number of colours supported, the RGB values are listed here. {Wx::TextAttrUnderlineType::TEXT_ATTR_UNDERLINE_SPECIAL} is shown as a waved line.
@@ -546,6 +565,7 @@ module Wx
     alias_method :font_weight=, :set_font_weight
     
     # Sets the left indent and left subindent in tenths of a millimetre.
+    # 
     # The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph.
     # A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.
     # {Wx::RTC::RichTextBuffer} uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.
@@ -556,6 +576,7 @@ module Wx
     alias_method :left_indent=, :set_left_indent
     
     # Sets the line spacing.
+    # 
     # spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing. The {Wx::TextAttrLineSpacing} values are defined for convenience.
     # @param spacing [Integer] 
     # @return [void]
@@ -569,6 +590,7 @@ module Wx
     alias_method :list_style_name=, :set_list_style_name
     
     # Specifies the outline level.
+    # 
     # Zero represents normal text. At present, the outline level is not used, but may be used in future for determining list levels and for applications that need to store document structure information.
     # @param level [Integer] 
     # @return [void]
@@ -606,6 +628,7 @@ module Wx
     alias_method :right_indent=, :set_right_indent
     
     # Sets the tab stops, expressed in tenths of a millimetre.
+    # 
     # Each stop is measured from the left margin and therefore each value must be larger than the last.
     # @param tabs [Array<Integer>] 
     # @return [void]
@@ -619,6 +642,7 @@ module Wx
     alias_method :text_colour=, :set_text_colour
     
     # Sets the text effect bits of interest.
+    # 
     # You should also pass {Wx::TextAttrFlags::TEXT_ATTR_EFFECTS} to {Wx::TextAttr#set_flags}. See {Wx::TextAttr#set_flags} for further information.
     # @param flags [Integer] 
     # @return [void]
@@ -626,6 +650,7 @@ module Wx
     alias_method :text_effect_flags=, :set_text_effect_flags
     
     # Sets the text effects, a bit list of styles.
+    # 
     # The {Wx::TextAttrEffects} enumeration values can be used.
     # Of these, only {Wx::TextAttrEffects::TEXT_ATTR_EFFECT_CAPITALS}, {Wx::TextAttrEffects::TEXT_ATTR_EFFECT_STRIKETHROUGH}, {Wx::TextAttrEffects::TEXT_ATTR_EFFECT_SUPERSCRIPT} and {Wx::TextAttrEffects::TEXT_ATTR_EFFECT_SUBSCRIPT} are implemented.
     # {Wx::TextAttrEffects::TEXT_ATTR_EFFECT_CAPITALS} capitalises text when displayed (leaving the case of the actual buffer text unchanged), and {Wx::TextAttrEffects::TEXT_ATTR_EFFECT_STRIKETHROUGH} draws a line through text.
@@ -636,6 +661,7 @@ module Wx
     alias_method :text_effects=, :set_text_effects
     
     # Sets the URL for the content.
+    # 
     # Sets the {Wx::TextAttrFlags::TEXT_ATTR_URL} style; content with this style causes {Wx::RTC::RichTextCtrl} to show a hand cursor over it, and {Wx::RTC::RichTextCtrl} generates a {Wx::TextUrlEvent} when the content is clicked.
     # @param url [String] 
     # @return [void]
@@ -654,6 +680,7 @@ module Wx
     def merge(overlay) end
     
     # Partial equality test.
+    # 
     # If weakTest is true, attributes of this object do not have to be present if those attributes of attr are present. If weakTest is false, the function will fail if an attribute is present in attr but not in this object.
     # @param attr [Wx::TextAttr] 
     # @param weakTest [Boolean] 

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

@@ -477,6 +477,7 @@ module Wx
   EVT_TEXT_MAXLEN = 10128
   
   # A text control allows text to be displayed and edited.
+  # 
   # It may be single line or multi-line. Notice that a lot of methods of the text controls are found in the base {Wx::TextEntry} class which is a common base class for {Wx::TextCtrl} and other controls using a single line text entry field (e.g. {Wx::ComboBox}).
   # ### Styles
   # 
@@ -635,11 +636,12 @@ module Wx
     #   @return [Wx::TextCtrl]
     # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::TEXT_CTRL_NAME_STR)
     #   Constructor, creating and showing a text control.
+    #   
     #   <div class="wxrb-remark">
     #   <b>Remark:</b>
     #   <p>The horizontal scrollbar ({Wx::HSCROLL} style flag) will only be created for multi-line text controls. Without a horizontal scrollbar, text lines that don't fit in the control's size will be wrapped (but no newline character is inserted). Single line controls don't have a horizontal scrollbar, the text is automatically scrolled so that the insertion point is always visible.
     #   </p>
-    #   </div>>
+    #   </div>
     #   @see Wx::TextCtrl#create
     #   @see  Wx::Validator 
     #   @param parent [Wx::Window]  Parent window. Should not be NULL.
@@ -654,6 +656,7 @@ module Wx
     def initialize(*args) end
     
     # Creates the text control for two-step construction.
+    # 
     # This method should be called if the default constructor was used for the control creation. Its parameters have the same meaning as for the non-default constructor.
     # @param parent [Wx::Window] 
     # @param id [Integer] 
@@ -671,11 +674,13 @@ module Wx
     def discard_edits; end
     
     # Delete the undo history.
+    # 
     # Currently only implemented in WXMSW (for controls using {Wx::TE_RICH2} style only) and WXOSX (for multiline text controls only), does nothing in the other ports or for the controls not using the appropriate styles.
     # @return [void]
     def empty_undo_buffer; end
     
     # This function inserts into the control the character which would have been inserted if the given key event had occurred in the text control.
+    # 
     # The event object should be the same as the one passed to EVT_KEY_DOWN handler previously by wxWidgets. Please note that this function doesn't currently work correctly for all keys under any platform but MSW.
     # true if the event resulted in a change to the control, false otherwise.
     # @param event [Wx::KeyEvent] 
@@ -684,12 +689,14 @@ module Wx
     
     # Returns the style currently used for the new text.
     # 
+    # 
     # @see Wx::TextCtrl#set_default_style 
     # @return [Wx::TextAttr]
     def get_default_style; end
     alias_method :default_style, :get_default_style
     
     # Gets the length of the specified line, not including any trailing newline character(s).
+    # 
     # The length of the line, or -1 if lineNo was invalid.
     # @param lineNo [Integer]  Line number (starting from zero).
     # @return [Integer]
@@ -697,6 +704,7 @@ module Wx
     alias_method :line_length, :get_line_length
     
     # Returns the contents of a given line in the text control, not including any trailing newline character(s).
+    # 
     # The contents of the line.
     # @param lineNo [Integer]  The line number, starting from zero.
     # @return [String]
@@ -704,18 +712,20 @@ module Wx
     alias_method :line_text, :get_line_text
     
     # Returns the number of lines in the text control buffer.
+    # 
     # The returned number is the number of logical lines, i.e. just the count of the number of newline characters in the control + 1, for WXGTK and WXOSX/Cocoa ports while it is the number of physical lines, i.e. the count of lines actually shown in the control, in WXMSW. Because of this discrepancy, it is not recommended to use this function.
     # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>Note that even empty text controls have one line (where the insertion point is), so {Wx::TextCtrl#get_number_of_lines} never returns 0. 
     # </p>
-    # </div>>
+    # </div>
     # @return [Integer]
     def get_number_of_lines; end
     alias_method :number_of_lines, :get_number_of_lines
     
     # Returns the style at this position in the text control.
+    # 
     # Not all platforms support this function.
     # true on success, false if an error occurred (this may also mean that the styles are not supported under this platform).
     # @see Wx::TextCtrl#set_style
@@ -727,6 +737,7 @@ module Wx
     alias_method :style, :get_style
     
     # Finds the row and column of the character at the specified point.
+    # 
     # If the return code is not {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} the row and column of the character closest to this position are returned, otherwise the output parameters are not modified.
     # Please note that this function is currently only implemented in {Wx::Univ}, WXMSW and WXGTK ports and always returns {Wx::TextCtrlHitTestResult::TE_HT_UNKNOWN} in the other ports.
     # @see Wx::TextCtrl#position_to_xy
@@ -736,6 +747,7 @@ module Wx
     def hit_test(pt) end
     
     # Returns true if the text has been modified by user.
+    # 
     # Note that calling {Wx::TextCtrl#set_value} doesn't make the control modified.
     # @see Wx::TextCtrl#mark_dirty 
     # @return [Boolean]
@@ -744,6 +756,7 @@ module Wx
     
     # Returns true if this is a multi line edit control and false otherwise.
     # 
+    # 
     # @see Wx::TextCtrl#is_single_line 
     # @return [Boolean]
     def is_multi_line; end
@@ -751,6 +764,7 @@ module Wx
     
     # Returns true if this is a single line edit control and false otherwise.
     # 
+    # 
     # @see Wx::TextCtrl#is_single_line
     # @see  Wx::TextCtrl#is_multi_line 
     # @return [Boolean]
@@ -758,6 +772,7 @@ module Wx
     alias_method :single_line?, :is_single_line
     
     # Loads and displays the named file, if it exists.
+    # 
     # true if successful, false otherwise.
     # @param filename [String]  The filename of the file to load.
     # @param fileType [Integer]  The type of file to load. This is currently ignored in {Wx::TextCtrl}.
@@ -766,22 +781,25 @@ module Wx
     
     # Mark text as modified (dirty).
     # 
+    # 
     # @see Wx::TextCtrl#is_modified 
     # @return [void]
     def mark_dirty; end
     
     # This event handler function implements default drag and drop behaviour, which is to load the first dropped file into the control.
+    # 
     # <div class="wxrb-remark">
     # <b>Remark:</b>
     # <p>This is not implemented on non-Windows platforms.
     # </p>
-    # </div>>
+    # </div>
     # @see Wx::DropFilesEvent 
     # @param event [Wx::DropFilesEvent]  The drop files event.
     # @return [void]
     def on_drop_files(event) end
     
     # Converts given position to a zero-based column, line number pair.
+    # 
     # true on success, false on failure (most likely due to a too large position parameter).
     # @see Wx::TextCtrl#xy_to_position 
     # @param pos [Integer]  Position.
@@ -789,6 +807,7 @@ module Wx
     def position_to_xy(pos) end
     
     # Converts given text position to client coordinates in pixels.
+    # 
     # This function allows finding where is the character at the given position displayed in the text control.
     # Availability:  only available for the WXMSW, WXGTK ports.   . Additionally, WXGTK only implements this method for multiline controls and {Wx::DEFAULT_POSITION} is always returned for the single line ones.
     # 
@@ -801,6 +820,7 @@ module Wx
     def position_to_coords(pos) end
     
     # Saves the contents of the control in a text file.
+    # 
     # true if the operation was successful, false otherwise.
     # @param filename [String]  The name of the file in which to save the text.
     # @param fileType [Integer]  The type of file to save. This is currently ignored in {Wx::TextCtrl}.
@@ -808,6 +828,7 @@ module Wx
     def save_file(filename=(''), fileType=Wx::TEXT_TYPE_ANY) end
     
     # Changes the default style to use for the new text which is going to be added to the control.
+    # 
     # This applies both to the text added programmatically using {Wx::TextCtrl#write_text} or {Wx::TextCtrl#append_text} and to the text entered by the user interactively.
     # If either of the font, foreground, or background colour is not set in style, the values of the previous default style are used for them. If the previous default style didn't set them either, the global font or colours of the text control itself are used as fall back.
     # However if the style parameter is the default {Wx::TextAttr}, then the default style is just reset (instead of being combined with the new style which wouldn't change it at all).
@@ -821,6 +842,7 @@ module Wx
     
     # Marks the control as being modified by the user or not.
     # 
+    # 
     # @see Wx::TextCtrl#mark_dirty
     # @see  Wx::TextCtrl#discard_edits 
     # @param modified [Boolean] 
@@ -829,6 +851,7 @@ module Wx
     alias_method :modified=, :set_modified
     
     # Changes the style of the given range.
+    # 
     # If any attribute within style is not set, the corresponding attribute from {Wx::TextCtrl#get_default_style} is used.
     # 
     # true on success, false if an error occurred (this may also mean that the styles are not supported under this platform).
@@ -846,6 +869,7 @@ module Wx
     def show_position(pos) end
     
     # Converts the given zero based column and line number to a position.
+    # 
     # The position value, or -1 if x or y was invalid.
     # @param x [Integer]  The column number.
     # @param y [Integer]  The line number.