X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..a7be99c8034b3a1fc9b2caf23cdae09eb738dff9:/interface/textctrl.h diff --git a/interface/textctrl.h b/interface/textctrl.h index f489c8e037..65cbd6e747 100644 --- a/interface/textctrl.h +++ b/interface/textctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: textctrl.h -// Purpose: documentation for wxTextAttr class +// Purpose: interface of wxTextAttr // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,8 +22,7 @@ @library{wxcore} @category{richtext} - @seealso - wxTextCtrl, wxRichTextCtrl + @see wxTextCtrl, wxRichTextCtrl */ class wxTextAttr { @@ -50,25 +49,25 @@ public: /** Creates a font from the font attributes. */ - wxFont CreateFont(); + wxFont CreateFont() const; /** Returns the alignment flags. See SetAlignment() for a list of available styles. */ - wxTextAttrAlignment GetAlignment(); + wxTextAttrAlignment GetAlignment() const; /** Returns the background colour. */ - const wxColour GetBackgroundColour(); + const wxColour GetBackgroundColour() const; /** Returns a string containing the name of the font associated with the bullet symbol. Only valid for attributes with wxTEXT_ATTR_BULLET_SYMBOL. */ - const wxString GetBulletFont(); + const wxString GetBulletFont() const; /** Returns the standard bullet name, applicable if the bullet style is @@ -84,35 +83,35 @@ public: DrawStandardBullet and @c EnumerateStandardBulletNames, and set an instance of the class using wxRichTextBuffer::SetRenderer. */ - const wxString GetBulletName(); + const wxString GetBulletName() const; /** Returns the bullet number. */ - int GetBulletNumber(); + int GetBulletNumber() const; /** Returns the bullet style. See SetBulletStyle() for a list of available styles. */ - int GetBulletStyle(); + int GetBulletStyle() const; /** Returns the bullet text, which could be a symbol, or (for example) cached outline text. */ - const wxString GetBulletText(); + const wxString GetBulletText() const; /** Returns the name of the character style. */ - const wxString GetCharacterStyleName(); + const wxString GetCharacterStyleName() const; /** Returns flags indicating which attributes are applicable. See SetFlags() for a list of available flags. */ - long GetFlags(); + long GetFlags() const; /** Creates and returns a font specified by the font attributes in the wxTextAttr @@ -121,7 +120,7 @@ public: For greater efficiency, access the font attributes directly. */ - wxFont GetFont(); + wxFont GetFont() const; /** Gets the font attributes from the given font, using only the attributes @@ -133,78 +132,78 @@ public: /** Returns the font encoding. */ - wxFontEncoding GetFontEncoding(); + wxFontEncoding GetFontEncoding() const; /** Returns the font face name. */ - const wxString GetFontFaceName(); + const wxString GetFontFaceName() const; /** Returns the font size in points. */ - int GetFontSize(); + int GetFontSize() const; /** Returns the font style. */ - int GetFontStyle(); + int GetFontStyle() const; /** Returns @true if the font is underlined. */ - bool GetFontUnderlined(); + bool GetFontUnderlined() const; /** Returns the font weight. */ - int GetFontWeight(); + int GetFontWeight() const; /** Returns the left indent in tenths of a millimetre. */ - long GetLeftIndent(); + long GetLeftIndent() const; /** Returns the left sub-indent in tenths of a millimetre. */ - long GetLeftSubIndent(); + long GetLeftSubIndent() const; /** Returns the line spacing value, one of wxTEXT_ATTR_LINE_SPACING_NORMAL, wxTEXT_ATTR_LINE_SPACING_HALF, and wxTEXT_ATTR_LINE_SPACING_TWICE. */ - int GetLineSpacing(); + int GetLineSpacing() const; /** Returns the name of the list style. */ - const wxString GetListStyleName(); + const wxString GetListStyleName() const; /** Returns the outline level. */ - bool GetOutlineLevel(); + bool GetOutlineLevel() const; /** Returns the space in tenths of a millimeter after the paragraph. */ - int GetParagraphSpacingAfter(); + int GetParagraphSpacingAfter() const; /** Returns the space in tenths of a millimeter before the paragraph. */ - int GetParagraphSpacingBefore(); + int GetParagraphSpacingBefore() const; /** Returns the name of the paragraph style. */ - const wxString GetParagraphStyleName(); + const wxString GetParagraphStyleName() const; /** Returns the right indent in tenths of a millimeter. */ - long GetRightIndent(); + long GetRightIndent() const; /** Returns an array of tab stops, each expressed in tenths of a millimeter. Each @@ -212,24 +211,24 @@ public: is measured from the left margin and therefore each value must be larger than the last. */ - const wxArrayInt GetTabs(); + const wxArrayInt GetTabs() const; /** Returns the text foreground colour. */ - const wxColour GetTextColour(); + const wxColour GetTextColour() const; /** Returns the text effect bits of interest. See SetFlags() for further information. */ - int GetTextEffectFlags(); + int GetTextEffectFlags() const; /** Returns the text effects, a bit list of styles. See SetTextEffects() for details. */ - int GetTextEffects(); + int GetTextEffects() const; /** Returns the URL for the content. Content with wxTEXT_ATTR_URL style @@ -237,170 +236,170 @@ public: generates a wxTextUrlEvent when the content is clicked. */ - const wxString GetURL(); + const wxString GetURL() const; /** Returns @true if the attribute object specifies alignment. */ - bool HasAlignment(); + bool HasAlignment() const; /** Returns @true if the attribute object specifies a background colour. */ - bool HasBackgroundColour(); + bool HasBackgroundColour() const; /** Returns @true if the attribute object specifies a standard bullet name. */ - bool HasBulletName(); + bool HasBulletName() const; /** Returns @true if the attribute object specifies a bullet number. */ - bool HasBulletNumber(); + bool HasBulletNumber() const; /** Returns @true if the attribute object specifies a bullet style. */ - bool HasBulletStyle(); + bool HasBulletStyle() const; /** Returns @true if the attribute object specifies bullet text (usually specifying a symbol). */ - bool HasBulletText(); + bool HasBulletText() const; /** Returns @true if the attribute object specifies a character style name. */ - bool HasCharacterStyleName(); + bool HasCharacterStyleName() const; /** Returns @true if the @a flag is present in the attribute object's flag bitlist. */ - bool HasFlag(long flag); + bool HasFlag(long flag) const; /** Returns @true if the attribute object specifies any font attributes. */ - bool HasFont(); + bool HasFont() const; /** Returns @true if the attribute object specifies an encoding. */ - bool HasFontEncoding(); + bool HasFontEncoding() const; /** Returns @true if the attribute object specifies a font face name. */ - bool HasFontFaceName(); + bool HasFontFaceName() const; /** Returns @true if the attribute object specifies italic style. */ - bool HasFontItalic(); + bool HasFontItalic() const; /** Returns @true if the attribute object specifies a font point size. */ - bool HasFontSize(); + bool HasFontSize() const; /** Returns @true if the attribute object specifies either underlining or no underlining. */ - bool HasFontUnderlined(); + bool HasFontUnderlined() const; /** Returns @true if the attribute object specifies font weight (bold, light or normal). */ - bool HasFontWeight(); + bool HasFontWeight() const; /** Returns @true if the attribute object specifies a left indent. */ - bool HasLeftIndent(); + bool HasLeftIndent() const; /** Returns @true if the attribute object specifies line spacing. */ - bool HasLineSpacing(); + bool HasLineSpacing() const; /** Returns @true if the attribute object specifies a list style name. */ - bool HasListStyleName(); + bool HasListStyleName() const; /** Returns @true if the attribute object specifies an outline level. */ - bool HasOutlineLevel(); + bool HasOutlineLevel() const; /** Returns @true if the attribute object specifies a page break before this paragraph. */ - bool HasPageBreak(); + bool HasPageBreak() const; /** Returns @true if the attribute object specifies spacing after a paragraph. */ - bool HasParagraphSpacingAfter(); + bool HasParagraphSpacingAfter() const; /** Returns @true if the attribute object specifies spacing before a paragraph. */ - bool HasParagraphSpacingBefore(); + bool HasParagraphSpacingBefore() const; /** Returns @true if the attribute object specifies a paragraph style name. */ - bool HasParagraphStyleName(); + bool HasParagraphStyleName() const; /** Returns @true if the attribute object specifies a right indent. */ - bool HasRightIndent(); + bool HasRightIndent() const; /** Returns @true if the attribute object specifies tab stops. */ - bool HasTabs(); + bool HasTabs() const; /** Returns @true if the attribute object specifies a text foreground colour. */ - bool HasTextColour(); + bool HasTextColour() const; /** Returns @true if the attribute object specifies text effects. */ - bool HasTextEffects(); + bool HasTextEffects() const; /** Returns @true if the attribute object specifies a URL. */ - bool HasURL(); + bool HasURL() const; /** Returns @true if the object represents a character style, that is, the flags specify a font or a text background or foreground colour. */ - bool IsCharacterStyle(); + bool IsCharacterStyle() const; /** Returns @false if we have any attributes set, @true otherwise. */ - bool IsDefault(); + bool IsDefault() const; /** Returns @true if the object represents a paragraph style, that is, the flags specify alignment, indentation, tabs, paragraph spacing, or bullet style. */ - bool IsParagraphStyle(); + bool IsParagraphStyle() const; //@{ /** @@ -416,7 +415,7 @@ public: /** Sets the paragraph alignment. These are the possible values for @e alignment: - + Of these, wxTEXT_ALIGNMENT_JUSTIFIED is unimplemented. In future justification may be supported when printing or previewing, only. @@ -449,7 +448,7 @@ public: /** Sets the bullet style. The following styles can be passed: - + Currently wxTEXT_ATTR_BULLET_STYLE_BITMAP is not supported. */ void SetBulletStyle(int style); @@ -594,7 +593,7 @@ public: /** Sets the text effects, a bit list of styles. The following styles can be passed: - + Of these, only wxTEXT_ATTR_EFFECT_CAPITALS and wxTEXT_ATTR_EFFECT_STRIKETHROUGH are implemented. wxTEXT_ATTR_EFFECT_CAPITALS capitalises text when displayed (leaving the case @@ -622,6 +621,7 @@ public: }; + /** @class wxTextCtrl @wxheader{textctrl.h} @@ -697,8 +697,7 @@ public: @category{ctrl} @appearance{textctrl.png} - @seealso - wxTextCtrl::Create, wxValidator + @see wxTextCtrl::Create, wxValidator */ class wxTextCtrl : public wxControl { @@ -706,7 +705,7 @@ public: //@{ /** Constructor, creating and showing a text control. - + @param parent Parent window. Should not be @NULL. @param id @@ -723,7 +722,7 @@ public: Window validator. @param name Window name. - + @remarks The horizontal scrollbar (wxHSCROLL style flag) will only be created for multi-line text controls. Without a horizontal scrollbar, text lines that don't fit in the @@ -731,7 +730,7 @@ public: 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. - + @see Create(), wxValidator */ wxTextCtrl(); @@ -751,15 +750,15 @@ public: /** Appends the text to the end of the text control. - + @param text Text to write to the text control. - + @remarks After the text is appended, the insertion point will be at the end of the text control. If this behaviour is not desired, the programmer should use GetInsertionPoint and SetInsertionPoint. - + @see WriteText() */ void AppendText(const wxString& text); @@ -769,12 +768,13 @@ public: text control using the given @e choices. Notice that currently this function is only implemented in wxGTK2 and wxMSW ports and does nothing under the other platforms. - This function is new since wxWidgets version 2.9.0 - + + @wxsince{2.9.0} + @returns @true if the auto-completion was enabled or @false if the operation failed, typically because auto-completion is not supported by the current platform. - + @see AutoCompleteFileNames() */ bool AutoComplete(const wxArrayString& choices); @@ -784,12 +784,13 @@ public: text control using all valid file system paths. Notice that currently this function is only implemented in wxGTK2 port and does nothing under the other platforms. - This function is new since wxWidgets version 2.9.0 - + + @wxsince{2.9.0} + @returns @true if the auto-completion was enabled or @false if the operation failed, typically because auto-completion is not supported by the current platform. - + @see AutoComplete() */ bool AutoCompleteFileNames(); @@ -831,8 +832,9 @@ public: event. This is the only difference with SetValue(). See @ref overview_progevent "this topic" for more information. - This function is new since wxWidgets version 2.7.1 - + + @wxsince{2.7.1} + @param value The new value to set. It may contain newline characters if the text control is multi-line. @@ -881,7 +883,7 @@ public: handler previously by wxWidgets. Please note that this function doesn't currently work correctly for all keys under any platform but MSW. - + @returns @true if the event resulted in a change to the control, @false otherwise. */ @@ -889,10 +891,10 @@ public: /** Returns the style currently used for the new text. - + @see SetDefaultStyle() */ - const wxTextAttr GetDefaultStyle(); + const wxTextAttr GetDefaultStyle() const; /** Returns the insertion point. This is defined as the zero based index of the @@ -903,44 +905,44 @@ public: The following code snippet safely returns the character at the insertion point or the zero character if the point is at the end of the control. */ - virtual long GetInsertionPoint(); + virtual long GetInsertionPoint() const; /** Returns the zero based index of the last position in the text control, which is equal to the number of characters in the control. */ - virtual wxTextPos GetLastPosition(); + virtual wxTextPos GetLastPosition() const; /** Gets the length of the specified line, not including any trailing newline character(s). - + @param lineNo Line number (starting from zero). - + @returns The length of the line, or -1 if lineNo was invalid. */ - int GetLineLength(long lineNo); + int GetLineLength(long lineNo) const; /** Returns the contents of a given line in the text control, not including any trailing newline character(s). - + @param lineNo The line number, starting from zero. - + @returns The contents of the line. */ - wxString GetLineText(long lineNo); + wxString GetLineText(long lineNo) const; /** Returns the number of lines in the text control buffer. - + @remarks Note that even empty text controls have one line (where the insertion point is), so GetNumberOfLines() never returns 0. */ - int GetNumberOfLines(); + int GetNumberOfLines() const; /** Returns the string containing the text starting in the positions @a from and @@ -953,7 +955,7 @@ public: obtain the correct results instead of extracting parts of the entire value. It may also be more efficient, especially if the control contains a lot of data. */ - virtual wxString GetRange(long from, long to); + virtual wxString GetRange(long from, long to) const; /** Gets the current selection span. If the returned values are equal, there was @@ -964,13 +966,13 @@ public: under Windows (at least,) you should use GetStringSelection() to get the selected text. - + @param from The returned first position. @param to The returned last position. */ - virtual void GetSelection(long* from, long* to); + virtual void GetSelection(long* from, long* to) const; /** Gets the text currently selected in the control. If there is no selection, the @@ -981,10 +983,10 @@ public: /** Returns the style at this position in the text control. Not all platforms support this function. - + @returns @true on success, @false if an error occurred - it may also mean that the styles are not supported under this platform. - + @see SetStyle(), wxTextAttr */ bool GetStyle(long position, wxTextAttr& style); @@ -995,7 +997,7 @@ public: under Windows where they are separated by a \r\n sequence in the native control. */ - wxString GetValue(); + wxString GetValue() const; /** This function finds the character at the specified position expressed in @@ -1004,12 +1006,12 @@ public: @a row parameters (unless the pointers are @NULL which is allowed). Please note that this function is currently only implemented in wxUniv, wxMSW and wxGTK2 ports. - + @see PositionToXY(), XYToPosition() */ wxTextCtrlHitTestResult HitTest(const wxPoint& pt, wxTextCoord col, - wxTextCoord row); + wxTextCoord row) const; /** Returns @true if the controls contents may be edited by user (note that it @@ -1017,48 +1019,49 @@ public: read-only mode by a previous call to SetEditable(). */ - bool IsEditable(); + bool IsEditable() const; /** Returns @true if the control is currently empty. This is the same as @c GetValue().empty() but can be much more efficient for the multiline controls containing big amounts of text. - This function is new since wxWidgets version 2.7.1 + + @wxsince{2.7.1} */ - bool IsEmpty(); + bool IsEmpty() const; /** Returns @true if the text has been modified by user. Note that calling SetValue() doesn't make the control modified. - + @see MarkDirty() */ - bool IsModified(); + bool IsModified() const; /** Returns @true if this is a multi line edit control and @false otherwise. - + @see IsSingleLine() */ - bool IsMultiLine(); + bool IsMultiLine() const; /** Returns @true if this is a single line edit control and @false otherwise. - + @see @ref issingleline() IsMultiLine */ - bool IsSingleLine(); + bool IsSingleLine() const; /** Loads and displays the named file, if it exists. - + @param filename The filename of the file to load. @param fileType The type of file to load. This is currently ignored in wxTextCtrl. - + @returns @true if successful, @false otherwise. */ bool LoadFile(const wxString& filename, @@ -1066,7 +1069,7 @@ public: /** Mark text as modified (dirty). - + @see IsModified() */ void MarkDirty(); @@ -1074,12 +1077,12 @@ public: /** This event handler function implements default drag and drop behaviour, which is to load the first dropped file into the control. - + @param event The drop files event. - + @remarks This is not implemented on non-Windows platforms. - + @see wxDropFilesEvent */ void OnDropFiles(wxDropFilesEvent& event); @@ -1091,20 +1094,20 @@ public: /** Converts given position to a zero-based column, line number pair. - + @param pos Position. @param x Receives zero based column number. @param y Receives zero based line number. - + @returns @true on success, @false on failure (most likely due to a too large position parameter). - + @see XYToPosition() */ - bool PositionToXY(long pos, long* x, long* y); + bool PositionToXY(long pos, long* x, long* y) const; /** If there is a redo facility and the last operation can be redone, redoes the @@ -1116,7 +1119,7 @@ public: /** Removes the text starting at the first given position up to (but not including) the character at the last position. - + @param from The first position. @param to @@ -1127,7 +1130,7 @@ public: /** Replaces the text starting at the first position up to (but not including) the character at the last position with the given text. - + @param from The first position. @param to @@ -1139,12 +1142,12 @@ public: /** Saves the contents of the control in a text file. - + @param filename The name of the file in which to save the text. @param fileType The type of file to save. This is currently ignored in wxTextCtrl. - + @returns @true if the operation was successful, @false otherwise. */ bool SaveFile(const wxString& filename, @@ -1161,30 +1164,30 @@ public: However if the @a style parameter is the default wxTextAttr, then the default style is just reset (instead of being combined with the new style which wouldn't change it at all). - + @param style The style for the new text. - + @returns @true on success, @false if an error occurred - may also mean that the styles are not supported under this platform. - + @see GetDefaultStyle() */ bool SetDefaultStyle(const wxTextAttr& style); /** Makes the text item editable or read-only, overriding the @b wxTE_READONLY flag. - + @param editable If @true, the control is editable. If @false, the control is read-only. - + @see IsEditable() */ virtual void SetEditable(const bool editable); /** Sets the insertion point at the given position. - + @param pos Position to set. */ @@ -1215,37 +1218,46 @@ public: /** Marks the control as being modified by the user or not. - + @see MarkDirty(), DiscardEdits() */ void SetModified(bool modified); /** - Selects the text starting at the first position up to (but not including) the - character at the last position. If both parameters are equal to -1 all text - in the control is selected. - + Selects the text starting at the first position up to (but not + including) the character at the last position. If both parameters are + equal to -1 all text in the control is selected. + @param from The first position. @param to The last position. + + @see SelectAll() */ virtual void SetSelection(long from, long to); + /** + Selects all text in the control. + + @see SetSelection() + */ + virtual void SelectAll(); + /** Changes the style of the given range. If any attribute within @a style is not set, the corresponding attribute from GetDefaultStyle() is used. - + @param start The start of the range to change. @param end The end of the range to change. @param style The new style for the range. - + @returns @true on success, @false if an error occurred - it may also mean that the styles are not supported under this platform. - + @see GetStyle(), wxTextAttr */ bool SetStyle(long start, long end, const wxTextAttr& style); @@ -1258,7 +1270,7 @@ public: event. This function is deprecated and should not be used in new code. Please use the ChangeValue() function instead. - + @param value The new value to set. It may contain newline characters if the text control is multi-line. @@ -1267,7 +1279,7 @@ public: /** Makes the line containing the given position visible. - + @param pos The position that should be visible. */ @@ -1282,10 +1294,10 @@ public: /** Writes the text into the text control at the current insertion position. - + @param text Text to write to the text control. - + @remarks Newlines in the text string are the only control characters allowed, and they will cause appropriate line breaks. See () and AppendText() for more @@ -1295,12 +1307,12 @@ public: /** Converts the given zero based column and line number to a position. - + @param x The column number. @param y The line number. - + @returns The position value, or -1 if x or y was invalid. */ long XYToPosition(long x, long y); @@ -1319,6 +1331,7 @@ public: }; + /** @class wxStreamToTextRedirector @wxheader{textctrl.h} @@ -1354,8 +1367,7 @@ public: @library{wxcore} @category{logging} - @seealso - wxTextCtrl + @see wxTextCtrl */ class wxStreamToTextRedirector { @@ -1363,7 +1375,7 @@ public: /** The constructor starts redirecting output sent to @a ostr or @e cout for the default parameter value to the text control @e text. - + @param text The text control to append output too, must be non-@NULL @param ostr @@ -1378,3 +1390,4 @@ public: */ ~wxStreamToTextRedirector(); }; +