X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..de022e4f1197d146e9bdd6aeb2ac0ee9cb217737:/interface/textctrl.h diff --git a/interface/textctrl.h b/interface/textctrl.h index 2ae1403b86..e8384c07b9 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 { @@ -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} @@ -630,65 +630,65 @@ public: single line or multi-line. @beginStyleTable - @style{wxTE_PROCESS_ENTER}: + @style{wxTE_PROCESS_ENTER} The control will generate the event wxEVT_COMMAND_TEXT_ENTER (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). - @style{wxTE_PROCESS_TAB}: + @style{wxTE_PROCESS_TAB} The control will receive wxEVT_CHAR events for TAB pressed - normally, TAB is used for passing to the next control in a dialog instead. For the control created with this style, you can still use Ctrl-Enter to pass to the next control from the keyboard. - @style{wxTE_MULTILINE}: + @style{wxTE_MULTILINE} The text control allows multiple lines. - @style{wxTE_PASSWORD}: + @style{wxTE_PASSWORD} The text will be echoed as asterisks. - @style{wxTE_READONLY}: + @style{wxTE_READONLY} The text will not be user-editable. - @style{wxTE_RICH}: + @style{wxTE_RICH} Use rich text control under Win32, this allows to have more than 64KB of text in the control even under Win9x. This style is ignored under other platforms. - @style{wxTE_RICH2}: + @style{wxTE_RICH2} Use rich text control version 2.0 or 3.0 under Win32, this style is ignored under other platforms - @style{wxTE_AUTO_URL}: + @style{wxTE_AUTO_URL} Highlight the URLs and generate the wxTextUrlEvents when mouse events occur over them. This style is only supported for wxTE_RICH Win32 and multi-line wxGTK2 text controls. - @style{wxTE_NOHIDESEL}: + @style{wxTE_NOHIDESEL} By default, the Windows text control doesn't show the selection when it doesn't have focus - use this style to force it to always show it. It doesn't do anything under other platforms. - @style{wxHSCROLL}: + @style{wxHSCROLL} A horizontal scrollbar will be created and used, so that text won't be wrapped. No effect under wxGTK1. - @style{wxTE_NO_VSCROLL}: + @style{wxTE_NO_VSCROLL} For multiline controls only: vertical scrollbar will never be created. This limits the amount of text which can be entered into the control to what can be displayed in it under MSW but not under GTK2. Currently not implemented for the other platforms. - @style{wxTE_LEFT}: + @style{wxTE_LEFT} The text in the control will be left-justified (default). - @style{wxTE_CENTRE}: + @style{wxTE_CENTRE} The text in the control will be centered (currently wxMSW and wxGTK2 only). - @style{wxTE_RIGHT}: + @style{wxTE_RIGHT} The text in the control will be right-justified (currently wxMSW and wxGTK2 only). - @style{wxTE_DONTWRAP}: + @style{wxTE_DONTWRAP} Same as wxHSCROLL style: don't wrap at all, show horizontal scrollbar instead. - @style{wxTE_CHARWRAP}: + @style{wxTE_CHARWRAP} Wrap the lines too long to be shown entirely at any position (wxUniv and wxGTK2 only). - @style{wxTE_WORDWRAP}: + @style{wxTE_WORDWRAP} Wrap the lines too long to be shown entirely at word boundaries (wxUniv and wxGTK2 only). - @style{wxTE_BESTWRAP}: + @style{wxTE_BESTWRAP} Wrap the lines at word boundaries or at any other character if there are words longer than the window width (this is the default). - @style{wxTE_CAPITALIZE}: + @style{wxTE_CAPITALIZE} On PocketPC and Smartphone, causes the first letter to be capitalized. @endStyleTable @@ -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,7 +891,7 @@ public: /** Returns the style currently used for the new text. - + @see SetDefaultStyle() */ const wxTextAttr GetDefaultStyle() const; @@ -914,10 +916,10 @@ public: /** 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) const; @@ -925,17 +927,17 @@ public: /** 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) 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. @@ -964,7 +966,7 @@ public: under Windows (at least,) you should use GetStringSelection() to get the selected text. - + @param from The returned first position. @param to @@ -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); @@ -1004,7 +1006,7 @@ 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, @@ -1023,14 +1025,15 @@ public: 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() 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() const; @@ -1038,7 +1041,7 @@ public: /** Returns @true if this is a multi line edit control and @false otherwise. - + @see IsSingleLine() */ bool IsMultiLine() const; @@ -1046,19 +1049,19 @@ public: /** Returns @true if this is a single line edit control and @false otherwise. - + @see @ref issingleline() IsMultiLine */ 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,17 +1094,17 @@ 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) const; @@ -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} @@ -1326,7 +1339,7 @@ public: This class can be used to (temporarily) redirect all output sent to a C++ ostream object to a wxTextCtrl instead. - @b NB: Some compilers and/or build configurations don't support multiply + @note Some compilers and/or build configurations don't support multiply inheriting wxTextCtrl from @c std::streambuf in which case this class is not compiled in. You also must have @c wxUSE_STD_IOSTREAM option on (i.e. set to 1) in your setup.h to be able to use it. Under Unix, @@ -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(); }; +