#include </home/zeitlin/src/wx/github/interface/wx/textctrl.h>

Inheritance diagram for wxTextCtrl:

Detailed Description

テキストの表示と編集が可能なテキストコントロール。

It may be single line or multi-line. Notice that a lot of methods of the text controls are found in the base wxTextEntry class which is a common base class for wxTextCtrl and other controls using a single line text entry field (e.g. wxComboBox).

Styles

This class supports the following styles:

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).
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.
wxTE_MULTILINE:
The text control allows multiple lines. If this style is not specified, line break characters should not be used in the controls value.
wxTE_PASSWORD:
The text will be echoed as asterisks.
wxTE_READONLY:
The text will not be user-editable.
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.
wxTE_RICH2:
Use rich text control version 2.0 or 3.0 under Win32, this style is ignored under other platforms
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.
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.
wxHSCROLL:
A horizontal scrollbar will be created and used, so that text won't be wrapped. No effect under wxGTK1.
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.
wxTE_LEFT:
The text in the control will be left-justified (default).
wxTE_CENTRE:
The text in the control will be centered (currently wxMSW and wxGTK2 only).
wxTE_RIGHT:
The text in the control will be right-justified (currently wxMSW and wxGTK2 only).
wxTE_DONTWRAP:
Same as wxHSCROLL style: don't wrap at all, show horizontal scrollbar instead.
wxTE_CHARWRAP:
Wrap the lines too long to be shown entirely at any position (wxUniv and wxGTK2 only).
wxTE_WORDWRAP:
Wrap the lines too long to be shown entirely at word boundaries (wxUniv and wxGTK2 only).
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).
wxTE_CAPITALIZE:
On PocketPC and Smartphone, causes the first letter to be capitalized.

Note that alignment styles (wxTE_LEFT, wxTE_CENTRE and wxTE_RIGHT) can be changed dynamically after control creation on wxMSW and wxGTK. wxTE_READONLY, wxTE_PASSWORD and wrapping styles can be dynamically changed under wxGTK but not wxMSW. The other styles can be only set during control creation.

wxTextCtrl Text Format

The multiline text controls always store the text as a sequence of lines separated by '\n' characters, i.e. in the Unix text format even on non-Unix platforms. This allows the user code to ignore the differences between the platforms but at a price: the indices in the control such as those returned by GetInsertionPoint() or GetSelection() can not be used as indices into the string returned by GetValue() as they're going to be slightly off for platforms using "\\r\\n" as separator (as Windows does).

Instead, if you need to obtain a substring between the 2 indices obtained from the control with the help of the functions mentioned above, you should use GetRange(). And the indices themselves can only be passed to other methods, for example SetInsertionPoint() or SetSelection().

To summarize: never use the indices returned by (multiline) wxTextCtrl as indices into the string it contains, but only as arguments to be passed back to the other wxTextCtrl methods. This problem doesn't arise for single-line platforms however where the indices in the control do correspond to the positions in the value string.

wxTextCtrl Styles.

Multi-line text controls support styling, i.e. provide a possibility to set colours and font for individual characters in it (note that under Windows wxTE_RICH style is required for style support). To use the styles you can either call SetDefaultStyle() before inserting the text or call SetStyle() later to change the style of the text already in the control (the first solution is much more efficient).

In either case, if the style doesn't specify some of the attributes (for example you only want to set the text colour but without changing the font nor the text background), the values of the default style will be used for them. If there is no default style, the attributes of the text control itself are used.

So the following code correctly describes what it does: the second call to SetDefaultStyle() doesn't change the text foreground colour (which stays red) while the last one doesn't change the background colour (which stays grey):

    text->SetDefaultStyle(wxTextAttr(*wxRED));
    text->AppendText("Red text\n");
    text->SetDefaultStyle(wxTextAttr(wxNullColour, *wxLIGHT_GREY));
    text->AppendText("Red on grey text\n");
    text->SetDefaultStyle(wxTextAttr(*wxBLUE);
    text->AppendText("Blue on grey text\n");

wxTextCtrl and C++ Streams

This class multiply-inherits from std::streambuf (except for some really old compilers using non-standard iostream library), allowing code such as the following:

    wxTextCtrl *control = new wxTextCtrl(...);

    ostream stream(control)

    stream << 123.456 << " some text\n";
    stream.flush();

Note that even if your compiler doesn't support this (the symbol wxHAS_TEXT_WINDOW_STREAM has value of 0 then) you can still use wxTextCtrl itself in a stream-like manner:

    wxTextCtrl *control = new wxTextCtrl(...);

    *control << 123.456 << " some text\n";

However the possibility to create an ostream associated with wxTextCtrl may be useful if you need to redirect the output of a function taking an ostream as parameter to a text control.

Another commonly requested need is to redirect std::cout to the text control. This may be done in the following way:

    #include <iostream>

    wxTextCtrl *control = new wxTextCtrl(...);

    std::streambuf *sbOld = std::cout.rdbuf();
    std::cout.rdbuf(control);

    // use cout as usual, the output appears in the text control
    ...

    std::cout.rdbuf(sbOld);

But wxWidgets provides a convenient class to make it even simpler so instead you may just do

    #include <iostream>

    wxTextCtrl *control = new wxTextCtrl(...);

    wxStreamToTextRedirector redirect(control);

    // all output to cout goes into the text control until the exit from
    // current scope

See wxStreamToTextRedirector for more details.

Event Handling.

The following commands are processed by default event handlers in wxTextCtrl: wxID_CUT, wxID_COPY, wxID_PASTE, wxID_UNDO, wxID_REDO. The associated UI update events are also processed automatically, when the control has the focus.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxCommandEvent& event)

Event macros for events emitted by this class:

EVT_TEXT(id, func):
Respond to a wxEVT_COMMAND_TEXT_UPDATED event, generated when the text changes. Notice that this event will be sent when the text controls contents changes -- whether this is due to user input or comes from the program itself (for example, if wxTextCtrl::SetValue() is called); see wxTextCtrl::ChangeValue() for a function which does not send this event. This event is however not sent during the control creation.
EVT_TEXT_ENTER(id, func):
Respond to a wxEVT_COMMAND_TEXT_ENTER event, generated when enter is pressed in a text control which must have wxTE_PROCESS_ENTER style for this event to be generated.
EVT_TEXT_URL(id, func):
A mouse event occurred over an URL in the text control (wxMSW and wxGTK2 only currently).
EVT_TEXT_MAXLEN(id, func):
This event is generated when the user tries to enter more text into the control than the limit set by wxTextCtrl::SetMaxLength(), see its description.

Library: wxCore

Category: Controls

Appearance:


wxMSW appearance	wxGTK appearance	wxMac appearance

参照:: wxTextCtrl::Create, wxValidator

Public Member Functions
	wxTextCtrl ()
	Default ctor.
	wxTextCtrl (wxWindow *parent, wxWindowID id, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxTextCtrlNameStr)
	Constructor, creating and showing a text control.
virtual	~wxTextCtrl ()
	Destructor, destroying the text control.
bool	Create (wxWindow *parent, wxWindowID id, const wxString &value=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxTextCtrlNameStr)
	Creates the text control for two-step construction.
virtual void	Cut ()
	Copies the selected text to the clipboard and removes the selection.
virtual void	DiscardEdits ()
	Resets the internal modified flag as if the current changes had been saved.
virtual bool	EmulateKeyPress (const wxKeyEvent &event)
	This function inserts into the control the character which would have been inserted if the given key event had occurred in the text control.
virtual const wxTextAttr &	GetDefaultStyle () const
	Returns the style currently used for the new text.
virtual int	GetLineLength (long lineNo) const
	Gets the length of the specified line, not including any trailing newline character(s).
virtual wxString	GetLineText (long lineNo) const
	Returns the contents of a given line in the text control, not including any trailing newline character(s).
virtual int	GetNumberOfLines () const
	Returns the number of lines in the text control buffer.
virtual bool	GetStyle (long position, wxTextAttr &style)
	Returns the style at this position in the text control.
virtual bool	IsModified () const
	Returns true if the text has been modified by user.
bool	IsMultiLine () const
	Returns true if this is a multi line edit control and false otherwise.
bool	IsSingleLine () const
	Returns true if this is a single line edit control and false otherwise.
bool	LoadFile (const wxString &filename, int fileType=wxTEXT_TYPE_ANY)
	Loads and displays the named file, if it exists.
virtual void	MarkDirty ()
	Mark text as modified (dirty).
void	OnDropFiles (wxDropFilesEvent &event)
	This event handler function implements default drag and drop behaviour, which is to load the first dropped file into the control.
virtual bool	PositionToXY (long pos, long x, long y) const
	Converts given position to a zero-based column, line number pair.
wxPoint	PositionToCoords (long pos) const
	Converts given text position to client coordinates in pixels.
bool	SaveFile (const wxString &filename=wxEmptyString, int fileType=wxTEXT_TYPE_ANY)
	Saves the contents of the control in a text file.
virtual bool	SetDefaultStyle (const wxTextAttr &style)
	Changes the default style to use for the new text which is going to be added to the control using WriteText() or AppendText().
void	SetModified (bool modified)
	Marks the control as being modified by the user or not.
virtual bool	SetStyle (long start, long end, const wxTextAttr &style)
	Changes the style of the given range.
virtual void	ShowPosition (long pos)
	Makes the line containing the given position visible.
virtual long	XYToPosition (long x, long y) const
	Converts the given zero based column and line number to a position.

wxTextCtrlHitTestResult	HitTest (const wxPoint &pt, long *pos) const
	This function finds the character at the specified position expressed in pixels.
wxTextCtrlHitTestResult	HitTest (const wxPoint &pt, wxTextCoord col, wxTextCoord row) const
	This function finds the character at the specified position expressed in pixels.

wxTextCtrl &	operator<< (const wxString &s)
	Operator definitions for appending to a text control.
wxTextCtrl &	operator<< (int i)
	Operator definitions for appending to a text control.
wxTextCtrl &	operator<< (long i)
	Operator definitions for appending to a text control.
wxTextCtrl &	operator<< (float f)
	Operator definitions for appending to a text control.
wxTextCtrl &	operator<< (double d)
	Operator definitions for appending to a text control.
wxTextCtrl &	operator<< (char c)
	Operator definitions for appending to a text control.
wxTextCtrl &	operator<< (wchar_t c)
	Operator definitions for appending to a text control.

List of all members.

Constructor & Destructor Documentation

wxTextCtrl::wxTextCtrl ( )

Default ctor.

wxTextCtrl::wxTextCtrl	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	value = `wxEmptyString`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `0`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `wxTextCtrlNameStr`
	)

Constructor, creating and showing a text control.

Parameters:

parent	Parent window. Should not be NULL.
id	Control identifier. A value of -1 denotes a default value.
value	Default text value.
pos	Text control position.
size	Text control size.
style	Window style. See wxTextCtrl.
validator	Window validator.
name	Window name.

注意:: 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 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.

参照:: Create(), wxValidator

virtual wxTextCtrl::~wxTextCtrl ( ) [virtual]

Destructor, destroying the text control.

Member Function Documentation

bool wxTextCtrl::Create	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	value = `wxEmptyString`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		long	style = `0`,
		const wxValidator &	validator = `wxDefaultValidator`,
		const wxString &	name = `wxTextCtrlNameStr`
	)

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.

Reimplemented in wxSearchCtrl.

virtual void wxTextCtrl::Cut ( ) [virtual]

Copies the selected text to the clipboard and removes the selection.

virtual void wxTextCtrl::DiscardEdits ( ) [virtual]

Resets the internal modified flag as if the current changes had been saved.

virtual bool wxTextCtrl::EmulateKeyPress ( const wxKeyEvent & event ) [virtual]

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.

Returns:: true if the event resulted in a change to the control, false otherwise.

virtual const wxTextAttr& wxTextCtrl::GetDefaultStyle ( ) const [virtual]

Returns the style currently used for the new text.

参照:: SetDefaultStyle()

virtual int wxTextCtrl::GetLineLength ( long lineNo ) const [virtual]

Gets the length of the specified line, not including any trailing newline character(s).

Parameters:

lineNo Line number (starting from zero).

Returns:: The length of the line, or -1 if lineNo was invalid.

virtual wxString wxTextCtrl::GetLineText ( long lineNo ) const [virtual]

Returns the contents of a given line in the text control, not including any trailing newline character(s).

Parameters:

lineNo The line number, starting from zero.

Returns:: The contents of the line.

virtual int wxTextCtrl::GetNumberOfLines ( ) const [virtual]

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 and wxOSX/Carbon. Because of this discrepancy, it is not recommended to use this function.

注意:: Note that even empty text controls have one line (where the insertion point is), so GetNumberOfLines() never returns 0.

virtual bool wxTextCtrl::GetStyle	(	long	position,
		wxTextAttr &	style
	)		`[virtual]`

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 (this may also mean that the styles are not supported under this platform).

参照:: SetStyle(), wxTextAttr

wxTextCtrlHitTestResult wxTextCtrl::HitTest	(	const wxPoint &	pt,
		long *	pos
	)		const

This function finds the character at the specified position expressed in pixels.

The two overloads of this method allow to find either the position of the character, as an index into the text control contents, or its row and column.

If the return code is not wxTE_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 wxUniv, wxMSW and wxGTK2 ports and always returns wxTE_HT_UNKNOWN in the other ports.

wxPerl Note: In wxPerl this function takes only the pt argument and returns a 3-element list (result, col, row).

Parameters:

pt	The position of the point to check, in window device coordinates.
col	Receives the column of the character at the given position. May be NULL.
row	Receives the row of the character at the given position. May be NULL.
pos	Receives the position of the character at the given position. May be NULL.

参照:: PositionToXY(), XYToPosition()

wxTextCtrlHitTestResult wxTextCtrl::HitTest	(	const wxPoint &	pt,
		wxTextCoord *	col,
		wxTextCoord *	row
	)		const

This function finds the character at the specified position expressed in pixels.

The two overloads of this method allow to find either the position of the character, as an index into the text control contents, or its row and column.

If the return code is not wxTE_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 wxUniv, wxMSW and wxGTK2 ports and always returns wxTE_HT_UNKNOWN in the other ports.

wxPerl Note: In wxPerl this function takes only the pt argument and returns a 3-element list (result, col, row).

Parameters:

pt	The position of the point to check, in window device coordinates.
col	Receives the column of the character at the given position. May be NULL.
row	Receives the row of the character at the given position. May be NULL.
pos	Receives the position of the character at the given position. May be NULL.

参照:: PositionToXY(), XYToPosition()

virtual bool wxTextCtrl::IsModified ( ) const [virtual]

Returns true if the text has been modified by user.

Note that calling SetValue() doesn't make the control modified.

参照:: MarkDirty()

bool wxTextCtrl::IsMultiLine ( ) const

Returns true if this is a multi line edit control and false otherwise.

参照:: IsSingleLine()

bool wxTextCtrl::IsSingleLine ( ) const

Returns true if this is a single line edit control and false otherwise.

参照:: IsSingleLine(), IsMultiLine()

bool wxTextCtrl::LoadFile	(	const wxString &	filename,
		int	fileType = `wxTEXT_TYPE_ANY`
	)

Loads and displays the named file, if it exists.

Parameters:

filename	The filename of the file to load.
fileType	The type of file to load. This is currently ignored in wxTextCtrl.

Returns:: true if successful, false otherwise.

virtual void wxTextCtrl::MarkDirty ( ) [virtual]

Mark text as modified (dirty).

参照:: IsModified()

void wxTextCtrl::OnDropFiles ( wxDropFilesEvent & event )

This event handler function implements default drag and drop behaviour, which is to load the first dropped file into the control.

Parameters:

event The drop files event.

注意:: This is not implemented on non-Windows platforms.

参照:: wxDropFilesEvent

wxTextCtrl& wxTextCtrl::operator<< ( wchar_t c )

Operator definitions for appending to a text control.