]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/textctrl.h
projects / wxWidgets.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Add forward declarations to fix wx/propgrid/editors.h compilation.
[wxWidgets.git] / include / wx / textctrl.h
... / ...
CommitLineData
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/textctrl.h
3// Purpose: wxTextAttr and wxTextCtrlBase class - the interface of wxTextCtrl
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 13.07.99
7// RCS-ID: $Id$
8// Copyright: (c) Vadim Zeitlin
9// Licence: wxWindows licence
10///////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_TEXTCTRL_H_BASE_
13#define _WX_TEXTCTRL_H_BASE_
14
15// ----------------------------------------------------------------------------
16// headers
17// ----------------------------------------------------------------------------
18
19#include "wx/defs.h"
20
21#if wxUSE_TEXTCTRL
22
23#include "wx/control.h" // the base class
24#include "wx/textentry.h" // single-line text entry interface
25#include "wx/dynarray.h" // wxArrayInt
26#include "wx/gdicmn.h" // wxPoint
27
28// some compilers don't have standard compliant rdbuf() (and MSVC has it only
29// in its new iostream library, not in the old one used with iostream.h)
30#if defined(__WATCOMC__) || \
31 defined(__MWERKS__) || \
32 ((defined(__VISUALC5__) || defined(__VISUALC6__)) && wxUSE_IOSTREAMH)
33 #define wxHAS_TEXT_WINDOW_STREAM 0
34#elif wxUSE_STD_IOSTREAM
35 #include "wx/ioswrap.h"
36 #define wxHAS_TEXT_WINDOW_STREAM 1
37#else
38 #define wxHAS_TEXT_WINDOW_STREAM 0
39#endif
40
41class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
42class WXDLLIMPEXP_FWD_CORE wxTextCtrlBase;
43
44// ----------------------------------------------------------------------------
45// wxTextCtrl types
46// ----------------------------------------------------------------------------
47
48// wxTextCoord is the line or row number (which should have been unsigned but
49// is long for backwards compatibility)
50typedef long wxTextCoord;
51
52// ----------------------------------------------------------------------------
53// constants
54// ----------------------------------------------------------------------------
55
56extern WXDLLIMPEXP_DATA_CORE(const char) wxTextCtrlNameStr[];
57
58// this is intentionally not enum to avoid warning fixes with
59// typecasting from enum type to wxTextCoord
60const wxTextCoord wxOutOfRangeTextCoord = -1;
61const wxTextCoord wxInvalidTextCoord = -2;
62
63// ----------------------------------------------------------------------------
64// wxTextCtrl style flags
65// ----------------------------------------------------------------------------
66
67#define wxTE_NO_VSCROLL 0x0002
68
69#define wxTE_READONLY 0x0010
70#define wxTE_MULTILINE 0x0020
71#define wxTE_PROCESS_TAB 0x0040
72
73// alignment flags
74#define wxTE_LEFT 0x0000 // 0x0000
75#define wxTE_CENTER wxALIGN_CENTER_HORIZONTAL // 0x0100
76#define wxTE_RIGHT wxALIGN_RIGHT // 0x0200
77#define wxTE_CENTRE wxTE_CENTER
78
79// this style means to use RICHEDIT control and does something only under wxMSW
80// and Win32 and is silently ignored under all other platforms
81#define wxTE_RICH 0x0080
82
83#define wxTE_PROCESS_ENTER 0x0400
84#define wxTE_PASSWORD 0x0800
85
86// automatically detect the URLs and generate the events when mouse is
87// moved/clicked over an URL
88//
89// this is for Win32 richedit and wxGTK2 multiline controls only so far
90#define wxTE_AUTO_URL 0x1000
91
92// by default, the Windows text control doesn't show the selection when it
93// doesn't have focus - use this style to force it to always show it
94#define wxTE_NOHIDESEL 0x2000
95
96// use wxHSCROLL to not wrap text at all, wxTE_CHARWRAP to wrap it at any
97// position and wxTE_WORDWRAP to wrap at words boundary
98//
99// if no wrapping style is given at all, the control wraps at word boundary
100#define wxTE_DONTWRAP wxHSCROLL
101#define wxTE_CHARWRAP 0x4000 // wrap at any position
102#define wxTE_WORDWRAP 0x0001 // wrap only at words boundaries
103#define wxTE_BESTWRAP 0x0000 // this is the default
104
105#if WXWIN_COMPATIBILITY_2_6
106 // obsolete synonym
107 #define wxTE_LINEWRAP wxTE_CHARWRAP
108#endif // WXWIN_COMPATIBILITY_2_6
109
110#if WXWIN_COMPATIBILITY_2_8
111 // this style is (or at least should be) on by default now, don't use it
112 #define wxTE_AUTO_SCROLL 0
113#endif // WXWIN_COMPATIBILITY_2_8
114
115// force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
116// wxTE_RICH controls - can be used together with or instead of wxTE_RICH
117#define wxTE_RICH2 0x8000
118
119// reuse wxTE_RICH2's value for CAPEDIT control on Windows CE
120#if defined(__SMARTPHONE__) || defined(__POCKETPC__)
121#define wxTE_CAPITALIZE wxTE_RICH2
122#else
123#define wxTE_CAPITALIZE 0
124#endif
125
126// ----------------------------------------------------------------------------
127// wxTextCtrl file types
128// ----------------------------------------------------------------------------
129
130#define wxTEXT_TYPE_ANY 0
131
132// ----------------------------------------------------------------------------
133// wxTextCtrl::HitTest return values
134// ----------------------------------------------------------------------------
135
136// the point asked is ...
137enum wxTextCtrlHitTestResult
138{
139 wxTE_HT_UNKNOWN = -2, // this means HitTest() is simply not implemented
140 wxTE_HT_BEFORE, // either to the left or upper
141 wxTE_HT_ON_TEXT, // directly on
142 wxTE_HT_BELOW, // below [the last line]
143 wxTE_HT_BEYOND // after [the end of line]
144};
145// ... the character returned
146
147// ----------------------------------------------------------------------------
148// Types for wxTextAttr
149// ----------------------------------------------------------------------------
150
151// Alignment
152
153enum wxTextAttrAlignment
154{
155 wxTEXT_ALIGNMENT_DEFAULT,
156 wxTEXT_ALIGNMENT_LEFT,
157 wxTEXT_ALIGNMENT_CENTRE,
158 wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
159 wxTEXT_ALIGNMENT_RIGHT,
160 wxTEXT_ALIGNMENT_JUSTIFIED
161};
162
163// Flags to indicate which attributes are being applied
164enum wxTextAttrFlags
165{
166 wxTEXT_ATTR_TEXT_COLOUR = 0x00000001,
167 wxTEXT_ATTR_BACKGROUND_COLOUR = 0x00000002,
168
169 wxTEXT_ATTR_FONT_FACE = 0x00000004,
170 wxTEXT_ATTR_FONT_SIZE = 0x00000008,
171 wxTEXT_ATTR_FONT_WEIGHT = 0x00000010,
172 wxTEXT_ATTR_FONT_ITALIC = 0x00000020,
173 wxTEXT_ATTR_FONT_UNDERLINE = 0x00000040,
174 wxTEXT_ATTR_FONT_STRIKETHROUGH = 0x08000000,
175 wxTEXT_ATTR_FONT_ENCODING = 0x02000000,
176 wxTEXT_ATTR_FONT_FAMILY = 0x04000000,
177 wxTEXT_ATTR_FONT = \
178 ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
179 wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE | wxTEXT_ATTR_FONT_STRIKETHROUGH | wxTEXT_ATTR_FONT_ENCODING | wxTEXT_ATTR_FONT_FAMILY ),
180
181 wxTEXT_ATTR_ALIGNMENT = 0x00000080,
182 wxTEXT_ATTR_LEFT_INDENT = 0x00000100,
183 wxTEXT_ATTR_RIGHT_INDENT = 0x00000200,
184 wxTEXT_ATTR_TABS = 0x00000400,
185 wxTEXT_ATTR_PARA_SPACING_AFTER = 0x00000800,
186 wxTEXT_ATTR_PARA_SPACING_BEFORE = 0x00001000,
187 wxTEXT_ATTR_LINE_SPACING = 0x00002000,
188 wxTEXT_ATTR_CHARACTER_STYLE_NAME = 0x00004000,
189 wxTEXT_ATTR_PARAGRAPH_STYLE_NAME = 0x00008000,
190 wxTEXT_ATTR_LIST_STYLE_NAME = 0x00010000,
191
192 wxTEXT_ATTR_BULLET_STYLE = 0x00020000,
193 wxTEXT_ATTR_BULLET_NUMBER = 0x00040000,
194 wxTEXT_ATTR_BULLET_TEXT = 0x00080000,
195 wxTEXT_ATTR_BULLET_NAME = 0x00100000,
196
197 wxTEXT_ATTR_BULLET = \
198 ( wxTEXT_ATTR_BULLET_STYLE | wxTEXT_ATTR_BULLET_NUMBER | wxTEXT_ATTR_BULLET_TEXT | \
199 wxTEXT_ATTR_BULLET_NAME ),
200
201
202 wxTEXT_ATTR_URL = 0x00200000,
203 wxTEXT_ATTR_PAGE_BREAK = 0x00400000,
204 wxTEXT_ATTR_EFFECTS = 0x00800000,
205 wxTEXT_ATTR_OUTLINE_LEVEL = 0x01000000,
206
207 /*!
208 * Character and paragraph combined styles
209 */
210
211 wxTEXT_ATTR_CHARACTER = \
212 (wxTEXT_ATTR_FONT|wxTEXT_ATTR_EFFECTS| \
213 wxTEXT_ATTR_BACKGROUND_COLOUR|wxTEXT_ATTR_TEXT_COLOUR|wxTEXT_ATTR_CHARACTER_STYLE_NAME|wxTEXT_ATTR_URL),
214
215 wxTEXT_ATTR_PARAGRAPH = \
216 (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
217 wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|\
218 wxTEXT_ATTR_BULLET|wxTEXT_ATTR_PARAGRAPH_STYLE_NAME|wxTEXT_ATTR_LIST_STYLE_NAME|wxTEXT_ATTR_OUTLINE_LEVEL|wxTEXT_ATTR_PAGE_BREAK),
219
220 wxTEXT_ATTR_ALL = (wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH)
221};
222
223/*!
224 * Styles for wxTextAttr::SetBulletStyle
225 */
226enum wxTextAttrBulletStyle
227{
228 wxTEXT_ATTR_BULLET_STYLE_NONE = 0x00000000,
229 wxTEXT_ATTR_BULLET_STYLE_ARABIC = 0x00000001,
230 wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER = 0x00000002,
231 wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER = 0x00000004,
232 wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER = 0x00000008,
233 wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER = 0x00000010,
234 wxTEXT_ATTR_BULLET_STYLE_SYMBOL = 0x00000020,
235 wxTEXT_ATTR_BULLET_STYLE_BITMAP = 0x00000040,
236 wxTEXT_ATTR_BULLET_STYLE_PARENTHESES = 0x00000080,
237 wxTEXT_ATTR_BULLET_STYLE_PERIOD = 0x00000100,
238 wxTEXT_ATTR_BULLET_STYLE_STANDARD = 0x00000200,
239 wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS = 0x00000400,
240 wxTEXT_ATTR_BULLET_STYLE_OUTLINE = 0x00000800,
241
242 wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT = 0x00000000,
243 wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT = 0x00001000,
244 wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE = 0x00002000
245};
246
247/*!
248 * Styles for wxTextAttr::SetTextEffects
249 */
250enum wxTextAttrEffects
251{
252 wxTEXT_ATTR_EFFECT_NONE = 0x00000000,
253 wxTEXT_ATTR_EFFECT_CAPITALS = 0x00000001,
254 wxTEXT_ATTR_EFFECT_SMALL_CAPITALS = 0x00000002,
255 wxTEXT_ATTR_EFFECT_STRIKETHROUGH = 0x00000004,
256 wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH = 0x00000008,
257 wxTEXT_ATTR_EFFECT_SHADOW = 0x00000010,
258 wxTEXT_ATTR_EFFECT_EMBOSS = 0x00000020,
259 wxTEXT_ATTR_EFFECT_OUTLINE = 0x00000040,
260 wxTEXT_ATTR_EFFECT_ENGRAVE = 0x00000080,
261 wxTEXT_ATTR_EFFECT_SUPERSCRIPT = 0x00000100,
262 wxTEXT_ATTR_EFFECT_SUBSCRIPT = 0x00000200
263};
264
265/*!
266 * Line spacing values
267 */
268enum wxTextAttrLineSpacing
269{
270 wxTEXT_ATTR_LINE_SPACING_NORMAL = 10,
271 wxTEXT_ATTR_LINE_SPACING_HALF = 15,
272 wxTEXT_ATTR_LINE_SPACING_TWICE = 20
273};
274
275// ----------------------------------------------------------------------------
276// wxTextAttr: a structure containing the visual attributes of a text
277// ----------------------------------------------------------------------------
278
279class WXDLLIMPEXP_CORE wxTextAttr
280{
281public:
282 // ctors
283 wxTextAttr() { Init(); }
284 wxTextAttr(const wxTextAttr& attr) { Init(); Copy(attr); }
285 wxTextAttr(const wxColour& colText,
286 const wxColour& colBack = wxNullColour,
287 const wxFont& font = wxNullFont,
288 wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
289
290 // Initialise this object.
291 void Init();
292
293 // Copy
294 void Copy(const wxTextAttr& attr);
295
296 // Assignment
297 void operator= (const wxTextAttr& attr);
298
299 // Equality test
300 bool operator== (const wxTextAttr& attr) const;
301
302 // Partial equality test
303 bool EqPartial(const wxTextAttr& attr) const;
304
305 // Get attributes from font.
306 bool GetFontAttributes(const wxFont& font, int flags = wxTEXT_ATTR_FONT);
307
308 // setters
309 void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
310 void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
311 void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
312 void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
313 void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
314 void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
315
316 void SetFontSize(int pointSize) { m_fontSize = pointSize; m_flags |= wxTEXT_ATTR_FONT_SIZE; }
317 void SetFontStyle(wxFontStyle fontStyle) { m_fontStyle = fontStyle; m_flags |= wxTEXT_ATTR_FONT_ITALIC; }
318 void SetFontWeight(wxFontWeight fontWeight) { m_fontWeight = fontWeight; m_flags |= wxTEXT_ATTR_FONT_WEIGHT; }
319 void SetFontFaceName(const wxString& faceName) { m_fontFaceName = faceName; m_flags |= wxTEXT_ATTR_FONT_FACE; }
320 void SetFontUnderlined(bool underlined) { m_fontUnderlined = underlined; m_flags |= wxTEXT_ATTR_FONT_UNDERLINE; }
321 void SetFontStrikethrough(bool strikethrough) { m_fontStrikethrough = strikethrough; m_flags |= wxTEXT_ATTR_FONT_STRIKETHROUGH; }
322 void SetFontEncoding(wxFontEncoding encoding) { m_fontEncoding = encoding; m_flags |= wxTEXT_ATTR_FONT_ENCODING; }
323 void SetFontFamily(wxFontFamily family) { m_fontFamily = family; m_flags |= wxTEXT_ATTR_FONT_FAMILY; }
324
325 // Set font
326 void SetFont(const wxFont& font, int flags = wxTEXT_ATTR_FONT) { GetFontAttributes(font, flags); }
327
328 void SetFlags(long flags) { m_flags = flags; }
329
330 void SetCharacterStyleName(const wxString& name) { m_characterStyleName = name; m_flags |= wxTEXT_ATTR_CHARACTER_STYLE_NAME; }
331 void SetParagraphStyleName(const wxString& name) { m_paragraphStyleName = name; m_flags |= wxTEXT_ATTR_PARAGRAPH_STYLE_NAME; }
332 void SetListStyleName(const wxString& name) { m_listStyleName = name; SetFlags(GetFlags() | wxTEXT_ATTR_LIST_STYLE_NAME); }
333 void SetParagraphSpacingAfter(int spacing) { m_paragraphSpacingAfter = spacing; m_flags |= wxTEXT_ATTR_PARA_SPACING_AFTER; }
334 void SetParagraphSpacingBefore(int spacing) { m_paragraphSpacingBefore = spacing; m_flags |= wxTEXT_ATTR_PARA_SPACING_BEFORE; }
335 void SetLineSpacing(int spacing) { m_lineSpacing = spacing; m_flags |= wxTEXT_ATTR_LINE_SPACING; }
336 void SetBulletStyle(int style) { m_bulletStyle = style; m_flags |= wxTEXT_ATTR_BULLET_STYLE; }
337 void SetBulletNumber(int n) { m_bulletNumber = n; m_flags |= wxTEXT_ATTR_BULLET_NUMBER; }
338 void SetBulletText(const wxString& text) { m_bulletText = text; m_flags |= wxTEXT_ATTR_BULLET_TEXT; }
339 void SetBulletFont(const wxString& bulletFont) { m_bulletFont = bulletFont; }
340 void SetBulletName(const wxString& name) { m_bulletName = name; m_flags |= wxTEXT_ATTR_BULLET_NAME; }
341 void SetURL(const wxString& url) { m_urlTarget = url; m_flags |= wxTEXT_ATTR_URL; }
342 void SetPageBreak(bool pageBreak = true) { SetFlags(pageBreak ? (GetFlags() | wxTEXT_ATTR_PAGE_BREAK) : (GetFlags() & ~wxTEXT_ATTR_PAGE_BREAK)); }
343 void SetTextEffects(int effects) { m_textEffects = effects; SetFlags(GetFlags() | wxTEXT_ATTR_EFFECTS); }
344 void SetTextEffectFlags(int effects) { m_textEffectFlags = effects; }
345 void SetOutlineLevel(int level) { m_outlineLevel = level; SetFlags(GetFlags() | wxTEXT_ATTR_OUTLINE_LEVEL); }
346
347 const wxColour& GetTextColour() const { return m_colText; }
348 const wxColour& GetBackgroundColour() const { return m_colBack; }
349 wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
350 const wxArrayInt& GetTabs() const { return m_tabs; }
351 long GetLeftIndent() const { return m_leftIndent; }
352 long GetLeftSubIndent() const { return m_leftSubIndent; }
353 long GetRightIndent() const { return m_rightIndent; }
354 long GetFlags() const { return m_flags; }
355
356 int GetFontSize() const { return m_fontSize; }
357 wxFontStyle GetFontStyle() const { return m_fontStyle; }
358 wxFontWeight GetFontWeight() const { return m_fontWeight; }
359 bool GetFontUnderlined() const { return m_fontUnderlined; }
360 bool GetFontStrikethrough() const { return m_fontStrikethrough; }
361 const wxString& GetFontFaceName() const { return m_fontFaceName; }
362 wxFontEncoding GetFontEncoding() const { return m_fontEncoding; }
363 wxFontFamily GetFontFamily() const { return m_fontFamily; }
364
365 wxFont GetFont() const;
366
367 const wxString& GetCharacterStyleName() const { return m_characterStyleName; }
368 const wxString& GetParagraphStyleName() const { return m_paragraphStyleName; }
369 const wxString& GetListStyleName() const { return m_listStyleName; }
370 int GetParagraphSpacingAfter() const { return m_paragraphSpacingAfter; }
371 int GetParagraphSpacingBefore() const { return m_paragraphSpacingBefore; }
372
373 int GetLineSpacing() const { return m_lineSpacing; }
374 int GetBulletStyle() const { return m_bulletStyle; }
375 int GetBulletNumber() const { return m_bulletNumber; }
376 const wxString& GetBulletText() const { return m_bulletText; }
377 const wxString& GetBulletFont() const { return m_bulletFont; }
378 const wxString& GetBulletName() const { return m_bulletName; }
379 const wxString& GetURL() const { return m_urlTarget; }
380 int GetTextEffects() const { return m_textEffects; }
381 int GetTextEffectFlags() const { return m_textEffectFlags; }
382 int GetOutlineLevel() const { return m_outlineLevel; }
383
384 // accessors
385 bool HasTextColour() const { return m_colText.IsOk() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
386 bool HasBackgroundColour() const { return m_colBack.IsOk() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
387 bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) && HasFlag(wxTEXT_ATTR_ALIGNMENT) ; }
388 bool HasTabs() const { return HasFlag(wxTEXT_ATTR_TABS) ; }
389 bool HasLeftIndent() const { return HasFlag(wxTEXT_ATTR_LEFT_INDENT); }
390 bool HasRightIndent() const { return HasFlag(wxTEXT_ATTR_RIGHT_INDENT); }
391 bool HasFontWeight() const { return HasFlag(wxTEXT_ATTR_FONT_WEIGHT); }
392 bool HasFontSize() const { return HasFlag(wxTEXT_ATTR_FONT_SIZE); }
393 bool HasFontItalic() const { return HasFlag(wxTEXT_ATTR_FONT_ITALIC); }
394 bool HasFontUnderlined() const { return HasFlag(wxTEXT_ATTR_FONT_UNDERLINE); }
395 bool HasFontStrikethrough() const { return HasFlag(wxTEXT_ATTR_FONT_STRIKETHROUGH); }
396 bool HasFontFaceName() const { return HasFlag(wxTEXT_ATTR_FONT_FACE); }
397 bool HasFontEncoding() const { return HasFlag(wxTEXT_ATTR_FONT_ENCODING); }
398 bool HasFontFamily() const { return HasFlag(wxTEXT_ATTR_FONT_FAMILY); }
399 bool HasFont() const { return HasFlag(wxTEXT_ATTR_FONT); }
400
401 bool HasParagraphSpacingAfter() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_AFTER); }
402 bool HasParagraphSpacingBefore() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_BEFORE); }
403 bool HasLineSpacing() const { return HasFlag(wxTEXT_ATTR_LINE_SPACING); }
404 bool HasCharacterStyleName() const { return HasFlag(wxTEXT_ATTR_CHARACTER_STYLE_NAME) && !m_characterStyleName.IsEmpty(); }
405 bool HasParagraphStyleName() const { return HasFlag(wxTEXT_ATTR_PARAGRAPH_STYLE_NAME) && !m_paragraphStyleName.IsEmpty(); }
406 bool HasListStyleName() const { return HasFlag(wxTEXT_ATTR_LIST_STYLE_NAME) || !m_listStyleName.IsEmpty(); }
407 bool HasBulletStyle() const { return HasFlag(wxTEXT_ATTR_BULLET_STYLE); }
408 bool HasBulletNumber() const { return HasFlag(wxTEXT_ATTR_BULLET_NUMBER); }
409 bool HasBulletText() const { return HasFlag(wxTEXT_ATTR_BULLET_TEXT); }
410 bool HasBulletName() const { return HasFlag(wxTEXT_ATTR_BULLET_NAME); }
411 bool HasURL() const { return HasFlag(wxTEXT_ATTR_URL); }
412 bool HasPageBreak() const { return HasFlag(wxTEXT_ATTR_PAGE_BREAK); }
413 bool HasTextEffects() const { return HasFlag(wxTEXT_ATTR_EFFECTS); }
414 bool HasTextEffect(int effect) const { return HasFlag(wxTEXT_ATTR_EFFECTS) && ((GetTextEffectFlags() & effect) != 0); }
415 bool HasOutlineLevel() const { return HasFlag(wxTEXT_ATTR_OUTLINE_LEVEL); }
416
417 bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
418 void RemoveFlag(long flag) { m_flags &= ~flag; }
419 void AddFlag(long flag) { m_flags |= flag; }
420
421 // Is this a character style?
422 bool IsCharacterStyle() const { return HasFlag(wxTEXT_ATTR_CHARACTER); }
423 bool IsParagraphStyle() const { return HasFlag(wxTEXT_ATTR_PARAGRAPH); }
424
425 // returns false if we have any attributes set, true otherwise
426 bool IsDefault() const
427 {
428 return GetFlags() == 0;
429 }
430
431 // Merges the given attributes. If compareWith
432 // is non-NULL, then it will be used to mask out those attributes that are the same in style
433 // and compareWith, for situations where we don't want to explicitly set inherited attributes.
434 bool Apply(const wxTextAttr& style, const wxTextAttr* compareWith = NULL);
435
436 // merges the attributes of the base and the overlay objects and returns
437 // the result; the parameter attributes take precedence
438 //
439 // WARNING: the order of arguments is the opposite of Combine()
440 static wxTextAttr Merge(const wxTextAttr& base, const wxTextAttr& overlay)
441 {
442 return Combine(overlay, base, NULL);
443 }
444
445 // merges the attributes of this object and overlay
446 void Merge(const wxTextAttr& overlay)
447 {
448 *this = Merge(*this, overlay);
449 }
450
451 // return the attribute having the valid font and colours: it uses the
452 // attributes set in attr and falls back first to attrDefault and then to
453 // the text control font/colours for those attributes which are not set
454 static wxTextAttr Combine(const wxTextAttr& attr,
455 const wxTextAttr& attrDef,
456 const wxTextCtrlBase *text);
457
458 // Compare tabs
459 static bool TabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2);
460
461 // Remove attributes
462 static bool RemoveStyle(wxTextAttr& destStyle, const wxTextAttr& style);
463
464 // Combine two bitlists, specifying the bits of interest with separate flags.
465 static bool CombineBitlists(int& valueA, int valueB, int& flagsA, int flagsB);
466
467 // Compare two bitlists
468 static bool BitlistsEqPartial(int valueA, int valueB, int flags);
469
470 // Split into paragraph and character styles
471 static bool SplitParaCharStyles(const wxTextAttr& style, wxTextAttr& parStyle, wxTextAttr& charStyle);
472
473private:
474 long m_flags;
475
476 // Paragraph styles
477 wxArrayInt m_tabs; // array of int: tab stops in 1/10 mm
478 int m_leftIndent; // left indent in 1/10 mm
479 int m_leftSubIndent; // left indent for all but the first
480 // line in a paragraph relative to the
481 // first line, in 1/10 mm
482 int m_rightIndent; // right indent in 1/10 mm
483 wxTextAttrAlignment m_textAlignment;
484
485 int m_paragraphSpacingAfter;
486 int m_paragraphSpacingBefore;
487 int m_lineSpacing;
488 int m_bulletStyle;
489 int m_bulletNumber;
490 int m_textEffects;
491 int m_textEffectFlags;
492 int m_outlineLevel;
493 wxString m_bulletText;
494 wxString m_bulletFont;
495 wxString m_bulletName;
496 wxString m_urlTarget;
497 wxFontEncoding m_fontEncoding;
498
499 // Character styles
500 wxColour m_colText,
501 m_colBack;
502 int m_fontSize;
503 wxFontStyle m_fontStyle;
504 wxFontWeight m_fontWeight;
505 wxFontFamily m_fontFamily;
506 bool m_fontUnderlined;
507 bool m_fontStrikethrough;
508 wxString m_fontFaceName;
509
510 // Character style
511 wxString m_characterStyleName;
512
513 // Paragraph style
514 wxString m_paragraphStyleName;
515
516 // List style
517 wxString m_listStyleName;
518};
519
520// ----------------------------------------------------------------------------
521// wxTextAreaBase: multiline text control specific methods
522// ----------------------------------------------------------------------------
523
524class WXDLLIMPEXP_CORE wxTextAreaBase
525{
526public:
527 wxTextAreaBase() { }
528 virtual ~wxTextAreaBase() { }
529
530 // lines access
531 // ------------
532
533 virtual int GetLineLength(long lineNo) const = 0;
534 virtual wxString GetLineText(long lineNo) const = 0;
535 virtual int GetNumberOfLines() const = 0;
536
537
538 // file IO
539 // -------
540
541 bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY)
542 { return DoLoadFile(file, fileType); }
543 bool SaveFile(const wxString& file = wxEmptyString,
544 int fileType = wxTEXT_TYPE_ANY);
545
546 // dirty flag handling
547 // -------------------
548
549 virtual bool IsModified() const = 0;
550 virtual void MarkDirty() = 0;
551 virtual void DiscardEdits() = 0;
552 void SetModified(bool modified)
553 {
554 if ( modified )
555 MarkDirty();
556 else
557 DiscardEdits();
558 }
559
560
561 // styles handling
562 // ---------------
563
564 // text control under some platforms supports the text styles: these
565 // methods allow to apply the given text style to the given selection or to
566 // set/get the style which will be used for all appended text
567 virtual bool SetStyle(long start, long end, const wxTextAttr& style) = 0;
568 virtual bool GetStyle(long position, wxTextAttr& style) = 0;
569 virtual bool SetDefaultStyle(const wxTextAttr& style) = 0;
570 virtual const wxTextAttr& GetDefaultStyle() const { return m_defaultStyle; }
571
572
573 // coordinates translation
574 // -----------------------
575
576 // translate between the position (which is just an index in the text ctrl
577 // considering all its contents as a single strings) and (x, y) coordinates
578 // which represent column and line.
579 virtual long XYToPosition(long x, long y) const = 0;
580 virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
581
582 // translate the given position (which is just an index in the text control)
583 // to client coordinates
584 wxPoint PositionToCoords(long pos) const;
585
586
587 virtual void ShowPosition(long pos) = 0;
588
589 // find the character at position given in pixels
590 //
591 // NB: pt is in device coords (not adjusted for the client area origin nor
592 // scrolling)
593 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
594 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
595 wxTextCoord *col,
596 wxTextCoord *row) const;
597 virtual wxString GetValue() const = 0;
598 virtual void SetValue(const wxString& value) = 0;
599
600protected:
601 // implementation of loading/saving
602 virtual bool DoLoadFile(const wxString& file, int fileType);
603 virtual bool DoSaveFile(const wxString& file, int fileType);
604
605 // Return true if the given position is valid, i.e. positive and less than
606 // the last position.
607 virtual bool IsValidPosition(long pos) const = 0;
608
609 // Default stub implementation of PositionToCoords() always returns
610 // wxDefaultPosition.
611 virtual wxPoint DoPositionToCoords(long pos) const;
612
613 // the name of the last file loaded with LoadFile() which will be used by
614 // SaveFile() by default
615 wxString m_filename;
616
617 // the text style which will be used for any new text added to the control
618 wxTextAttr m_defaultStyle;
619
620
621 wxDECLARE_NO_COPY_CLASS(wxTextAreaBase);
622};
623
624// this class defines wxTextCtrl interface, wxTextCtrlBase actually implements
625// too much things because it derives from wxTextEntry and not wxTextEntryBase
626// and so any classes which "look like" wxTextCtrl (such as wxRichTextCtrl)
627// but don't need the (native) implementation bits from wxTextEntry should
628// actually derive from this one and not wxTextCtrlBase
629class WXDLLIMPEXP_CORE wxTextCtrlIface : public wxTextAreaBase,
630 public wxTextEntryBase
631{
632public:
633 wxTextCtrlIface() { }
634
635 // wxTextAreaBase overrides
636 virtual wxString GetValue() const
637 {
638 return wxTextEntryBase::GetValue();
639 }
640 virtual void SetValue(const wxString& value)
641 {
642 wxTextEntryBase::SetValue(value);
643 }
644
645protected:
646 virtual bool IsValidPosition(long pos) const
647 {
648 return pos >= 0 && pos <= GetLastPosition();
649 }
650
651private:
652 wxDECLARE_NO_COPY_CLASS(wxTextCtrlIface);
653};
654
655// ----------------------------------------------------------------------------
656// wxTextCtrl: a single or multiple line text zone where user can edit text
657// ----------------------------------------------------------------------------
658
659class WXDLLIMPEXP_CORE wxTextCtrlBase : public wxControl,
660#if wxHAS_TEXT_WINDOW_STREAM
661 public wxSTD streambuf,
662#endif
663 public wxTextAreaBase,
664 public wxTextEntry
665{
666public:
667 // creation
668 // --------
669
670 wxTextCtrlBase() { }
671 virtual ~wxTextCtrlBase() { }
672
673
674 // more readable flag testing methods
675 bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE); }
676 bool IsMultiLine() const { return !IsSingleLine(); }
677
678 // stream-like insertion operators: these are always available, whether we
679 // were, or not, compiled with streambuf support
680 wxTextCtrl& operator<<(const wxString& s);
681 wxTextCtrl& operator<<(int i);
682 wxTextCtrl& operator<<(long i);
683 wxTextCtrl& operator<<(float f) { return *this << double(f); }
684 wxTextCtrl& operator<<(double d);
685 wxTextCtrl& operator<<(char c) { return *this << wxString(c); }
686 wxTextCtrl& operator<<(wchar_t c) { return *this << wxString(c); }
687
688 // insert the character which would have resulted from this key event,
689 // return true if anything has been inserted
690 virtual bool EmulateKeyPress(const wxKeyEvent& event);
691
692
693 // do the window-specific processing after processing the update event
694 virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
695
696 virtual bool ShouldInheritColours() const { return false; }
697
698 // work around the problem with having HitTest() both in wxControl and
699 // wxTextAreaBase base classes
700 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const
701 {
702 return wxTextAreaBase::HitTest(pt, pos);
703 }
704
705 virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
706 wxTextCoord *col,
707 wxTextCoord *row) const
708 {
709 return wxTextAreaBase::HitTest(pt, col, row);
710 }
711
712 // we provide stubs for these functions as not all platforms have styles
713 // support, but we really should leave them pure virtual here
714 virtual bool SetStyle(long start, long end, const wxTextAttr& style);
715 virtual bool GetStyle(long position, wxTextAttr& style);
716 virtual bool SetDefaultStyle(const wxTextAttr& style);
717
718 // wxTextAreaBase overrides
719 virtual wxString GetValue() const
720 {
721 return wxTextEntry::GetValue();
722 }
723 virtual void SetValue(const wxString& value)
724 {
725 wxTextEntry::SetValue(value);
726 }
727
728 // wxWindow overrides
729 virtual wxVisualAttributes GetDefaultAttributes() const
730 {
731 return GetClassDefaultAttributes(GetWindowVariant());
732 }
733
734 static wxVisualAttributes
735 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
736 {
737 return GetCompositeControlsDefaultAttributes(variant);
738 }
739
740protected:
741 // override streambuf method
742#if wxHAS_TEXT_WINDOW_STREAM
743 int overflow(int i);
744#endif // wxHAS_TEXT_WINDOW_STREAM
745
746 virtual bool DoLoadFile(const wxString& file, int fileType);
747 virtual bool DoSaveFile(const wxString& file, int fileType);
748
749 // Another wxTextAreaBase override.
750 virtual bool IsValidPosition(long pos) const
751 {
752 return pos >= 0 && pos <= GetLastPosition();
753 }
754
755 // implement the wxTextEntry pure virtual method
756 virtual wxWindow *GetEditableWindow() { return this; }
757
758 wxDECLARE_NO_COPY_CLASS(wxTextCtrlBase);
759 DECLARE_ABSTRACT_CLASS(wxTextCtrlBase)
760};
761
762// ----------------------------------------------------------------------------
763// include the platform-dependent class definition
764// ----------------------------------------------------------------------------
765
766#if defined(__WXX11__)
767 #include "wx/x11/textctrl.h"
768#elif defined(__WXUNIVERSAL__)
769 #include "wx/univ/textctrl.h"
770#elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
771 #include "wx/msw/wince/textctrlce.h"
772#elif defined(__WXMSW__)
773 #include "wx/msw/textctrl.h"
774#elif defined(__WXMOTIF__)
775 #include "wx/motif/textctrl.h"
776#elif defined(__WXGTK20__)
777 #include "wx/gtk/textctrl.h"
778#elif defined(__WXGTK__)
779 #include "wx/gtk1/textctrl.h"
780#elif defined(__WXMAC__)
781 #include "wx/osx/textctrl.h"
782#elif defined(__WXCOCOA__)
783 #include "wx/cocoa/textctrl.h"
784#elif defined(__WXPM__)
785 #include "wx/os2/textctrl.h"
786#endif
787
788// ----------------------------------------------------------------------------
789// wxTextCtrl events
790// ----------------------------------------------------------------------------
791
792class WXDLLIMPEXP_FWD_CORE wxTextUrlEvent;
793
794wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEvent);
795wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_ENTER, wxCommandEvent);
796wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_URL, wxTextUrlEvent);
797wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_MAXLEN, wxCommandEvent);
798
799class WXDLLIMPEXP_CORE wxTextUrlEvent : public wxCommandEvent
800{
801public:
802 wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
803 long start, long end)
804 : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, winid),
805 m_evtMouse(evtMouse), m_start(start), m_end(end)
806 { }
807 wxTextUrlEvent(const wxTextUrlEvent& event)
808 : wxCommandEvent(event),
809 m_evtMouse(event.m_evtMouse),
810 m_start(event.m_start),
811 m_end(event.m_end) { }
812
813 // get the mouse event which happend over the URL
814 const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
815
816 // get the start of the URL
817 long GetURLStart() const { return m_start; }
818
819 // get the end of the URL
820 long GetURLEnd() const { return m_end; }
821
822 virtual wxEvent *Clone() const { return new wxTextUrlEvent(*this); }
823
824protected:
825 // the corresponding mouse event
826 wxMouseEvent m_evtMouse;
827
828 // the start and end indices of the URL in the text control
829 long m_start,
830 m_end;
831
832private:
833 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTextUrlEvent)
834
835public:
836 // for wxWin RTTI only, don't use
837 wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
838};
839
840typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
841
842#define wxTextEventHandler(func) wxCommandEventHandler(func)
843#define wxTextUrlEventHandler(func) \
844 wxEVENT_HANDLER_CAST(wxTextUrlEventFunction, func)
845
846#define wx__DECLARE_TEXTEVT(evt, id, fn) \
847 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
848
849#define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
850 wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
851
852#define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
853#define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
854#define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
855#define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
856
857#if wxHAS_TEXT_WINDOW_STREAM
858
859// ----------------------------------------------------------------------------
860// wxStreamToTextRedirector: this class redirects all data sent to the given
861// C++ stream to the wxTextCtrl given to its ctor during its lifetime.
862// ----------------------------------------------------------------------------
863
864class WXDLLIMPEXP_CORE wxStreamToTextRedirector
865{
866private:
867 void Init(wxTextCtrl *text)
868 {
869 m_sbufOld = m_ostr.rdbuf();
870 m_ostr.rdbuf(text);
871 }
872
873public:
874 wxStreamToTextRedirector(wxTextCtrl *text)
875 : m_ostr(wxSTD cout)
876 {
877 Init(text);
878 }
879
880 wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
881 : m_ostr(*ostr)
882 {
883 Init(text);
884 }
885
886 ~wxStreamToTextRedirector()
887 {
888 m_ostr.rdbuf(m_sbufOld);
889 }
890
891private:
892 // the stream we're redirecting
893 wxSTD ostream& m_ostr;
894
895 // the old streambuf (before we changed it)
896 wxSTD streambuf *m_sbufOld;
897};
898
899#endif // wxHAS_TEXT_WINDOW_STREAM
900
901#endif // wxUSE_TEXTCTRL
902
903#endif
904 // _WX_TEXTCTRL_H_BASE_
wxWidgets (Impactor)