include/wx/textctrl.h

   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
  41 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
  42 class 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)
  50 typedef long wxTextCoord;
  51
  52 // ----------------------------------------------------------------------------
  53 // constants
  54 // ----------------------------------------------------------------------------
  55
  56 extern 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
  60 const wxTextCoord wxOutOfRangeTextCoord = -1;
  61 const 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 ...
 137 enum 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
 153 enum 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
 164 enum 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_ENCODING        = 0x02000000,
 175     wxTEXT_ATTR_FONT_FAMILY          = 0x04000000,
 176     wxTEXT_ATTR_FONT = \
 177         ( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
 178             wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE | wxTEXT_ATTR_FONT_ENCODING | wxTEXT_ATTR_FONT_FAMILY ),
 179
 180     wxTEXT_ATTR_ALIGNMENT            = 0x00000080,
 181     wxTEXT_ATTR_LEFT_INDENT          = 0x00000100,
 182     wxTEXT_ATTR_RIGHT_INDENT         = 0x00000200,
 183     wxTEXT_ATTR_TABS                 = 0x00000400,
 184     wxTEXT_ATTR_PARA_SPACING_AFTER   = 0x00000800,
 185     wxTEXT_ATTR_PARA_SPACING_BEFORE  = 0x00001000,
 186     wxTEXT_ATTR_LINE_SPACING         = 0x00002000,
 187     wxTEXT_ATTR_CHARACTER_STYLE_NAME = 0x00004000,
 188     wxTEXT_ATTR_PARAGRAPH_STYLE_NAME = 0x00008000,
 189     wxTEXT_ATTR_LIST_STYLE_NAME      = 0x00010000,
 190
 191     wxTEXT_ATTR_BULLET_STYLE         = 0x00020000,
 192     wxTEXT_ATTR_BULLET_NUMBER        = 0x00040000,
 193     wxTEXT_ATTR_BULLET_TEXT          = 0x00080000,
 194     wxTEXT_ATTR_BULLET_NAME          = 0x00100000,
 195
 196     wxTEXT_ATTR_BULLET = \
 197         ( wxTEXT_ATTR_BULLET_STYLE | wxTEXT_ATTR_BULLET_NUMBER | wxTEXT_ATTR_BULLET_TEXT | \
 198           wxTEXT_ATTR_BULLET_NAME ),
 199
 200
 201     wxTEXT_ATTR_URL                  = 0x00200000,
 202     wxTEXT_ATTR_PAGE_BREAK           = 0x00400000,
 203     wxTEXT_ATTR_EFFECTS              = 0x00800000,
 204     wxTEXT_ATTR_OUTLINE_LEVEL        = 0x01000000,
 205
 206     /*!
 207     * Character and paragraph combined styles
 208     */
 209
 210     wxTEXT_ATTR_CHARACTER = \
 211         (wxTEXT_ATTR_FONT|wxTEXT_ATTR_EFFECTS| \
 212             wxTEXT_ATTR_BACKGROUND_COLOUR|wxTEXT_ATTR_TEXT_COLOUR|wxTEXT_ATTR_CHARACTER_STYLE_NAME|wxTEXT_ATTR_URL),
 213
 214     wxTEXT_ATTR_PARAGRAPH = \
 215         (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
 216             wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|\
 217             wxTEXT_ATTR_BULLET|wxTEXT_ATTR_PARAGRAPH_STYLE_NAME|wxTEXT_ATTR_LIST_STYLE_NAME|wxTEXT_ATTR_OUTLINE_LEVEL),
 218
 219     wxTEXT_ATTR_ALL = (wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH)
 220 };
 221
 222 /*!
 223  * Styles for wxTextAttr::SetBulletStyle
 224  */
 225 enum wxTextAttrBulletStyle
 226 {
 227     wxTEXT_ATTR_BULLET_STYLE_NONE            = 0x00000000,
 228     wxTEXT_ATTR_BULLET_STYLE_ARABIC          = 0x00000001,
 229     wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER   = 0x00000002,
 230     wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER   = 0x00000004,
 231     wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER     = 0x00000008,
 232     wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER     = 0x00000010,
 233     wxTEXT_ATTR_BULLET_STYLE_SYMBOL          = 0x00000020,
 234     wxTEXT_ATTR_BULLET_STYLE_BITMAP          = 0x00000040,
 235     wxTEXT_ATTR_BULLET_STYLE_PARENTHESES     = 0x00000080,
 236     wxTEXT_ATTR_BULLET_STYLE_PERIOD          = 0x00000100,
 237     wxTEXT_ATTR_BULLET_STYLE_STANDARD        = 0x00000200,
 238     wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS = 0x00000400,
 239     wxTEXT_ATTR_BULLET_STYLE_OUTLINE         = 0x00000800,
 240
 241     wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT      = 0x00000000,
 242     wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT     = 0x00001000,
 243     wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE    = 0x00002000
 244 };
 245
 246 /*!
 247  * Styles for wxTextAttr::SetTextEffects
 248  */
 249 enum wxTextAttrEffects
 250 {
 251     wxTEXT_ATTR_EFFECT_NONE                  = 0x00000000,
 252     wxTEXT_ATTR_EFFECT_CAPITALS              = 0x00000001,
 253     wxTEXT_ATTR_EFFECT_SMALL_CAPITALS        = 0x00000002,
 254     wxTEXT_ATTR_EFFECT_STRIKETHROUGH         = 0x00000004,
 255     wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH  = 0x00000008,
 256     wxTEXT_ATTR_EFFECT_SHADOW                = 0x00000010,
 257     wxTEXT_ATTR_EFFECT_EMBOSS                = 0x00000020,
 258     wxTEXT_ATTR_EFFECT_OUTLINE               = 0x00000040,
 259     wxTEXT_ATTR_EFFECT_ENGRAVE               = 0x00000080,
 260     wxTEXT_ATTR_EFFECT_SUPERSCRIPT           = 0x00000100,
 261     wxTEXT_ATTR_EFFECT_SUBSCRIPT             = 0x00000200
 262 };
 263
 264 /*!
 265  * Line spacing values
 266  */
 267 enum wxTextAttrLineSpacing
 268 {
 269     wxTEXT_ATTR_LINE_SPACING_NORMAL         = 10,
 270     wxTEXT_ATTR_LINE_SPACING_HALF           = 15,
 271     wxTEXT_ATTR_LINE_SPACING_TWICE          = 20
 272 };
 273
 274 // ----------------------------------------------------------------------------
 275 // wxTextAttr: a structure containing the visual attributes of a text
 276 // ----------------------------------------------------------------------------
 277
 278 class WXDLLIMPEXP_CORE wxTextAttr
 279 {
 280 public:
 281     // ctors
 282     wxTextAttr() { Init(); }
 283     wxTextAttr(const wxTextAttr& attr) { Init(); Copy(attr); }
 284     wxTextAttr(const wxColour& colText,
 285                const wxColour& colBack = wxNullColour,
 286                const wxFont& font = wxNullFont,
 287                wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
 288
 289     // Initialise this object.
 290     void Init();
 291
 292     // Copy
 293     void Copy(const wxTextAttr& attr);
 294
 295     // Assignment
 296     void operator= (const wxTextAttr& attr);
 297
 298     // Equality test
 299     bool operator== (const wxTextAttr& attr) const;
 300
 301     // Partial equality test taking flags into account
 302     bool EqPartial(const wxTextAttr& attr, int flags) const;
 303
 304     // Get attributes from font.
 305     bool GetFontAttributes(const wxFont& font, int flags = wxTEXT_ATTR_FONT);
 306
 307     // setters
 308     void SetTextColour(const wxColour& colText) { m_colText = colText; m_flags |= wxTEXT_ATTR_TEXT_COLOUR; }
 309     void SetBackgroundColour(const wxColour& colBack) { m_colBack = colBack; m_flags |= wxTEXT_ATTR_BACKGROUND_COLOUR; }
 310     void SetAlignment(wxTextAttrAlignment alignment) { m_textAlignment = alignment; m_flags |= wxTEXT_ATTR_ALIGNMENT; }
 311     void SetTabs(const wxArrayInt& tabs) { m_tabs = tabs; m_flags |= wxTEXT_ATTR_TABS; }
 312     void SetLeftIndent(int indent, int subIndent = 0) { m_leftIndent = indent; m_leftSubIndent = subIndent; m_flags |= wxTEXT_ATTR_LEFT_INDENT; }
 313     void SetRightIndent(int indent) { m_rightIndent = indent; m_flags |= wxTEXT_ATTR_RIGHT_INDENT; }
 314
 315     void SetFontSize(int pointSize) { m_fontSize = pointSize; m_flags |= wxTEXT_ATTR_FONT_SIZE; }
 316     void SetFontStyle(wxFontStyle fontStyle) { m_fontStyle = fontStyle; m_flags |= wxTEXT_ATTR_FONT_ITALIC; }
 317     void SetFontWeight(wxFontWeight fontWeight) { m_fontWeight = fontWeight; m_flags |= wxTEXT_ATTR_FONT_WEIGHT; }
 318     void SetFontFaceName(const wxString& faceName) { m_fontFaceName = faceName; m_flags |= wxTEXT_ATTR_FONT_FACE; }
 319     void SetFontUnderlined(bool underlined) { m_fontUnderlined = underlined; m_flags |= wxTEXT_ATTR_FONT_UNDERLINE; }
 320     void SetFontEncoding(wxFontEncoding encoding) { m_fontEncoding = encoding; m_flags |= wxTEXT_ATTR_FONT_ENCODING; }
 321     void SetFontFamily(wxFontFamily family) { m_fontFamily = family; m_flags |= wxTEXT_ATTR_FONT_FAMILY; }
 322
 323     // Set font
 324     void SetFont(const wxFont& font, int flags = wxTEXT_ATTR_FONT) { GetFontAttributes(font, flags); }
 325
 326     void SetFlags(long flags) { m_flags = flags; }
 327
 328     void SetCharacterStyleName(const wxString& name) { m_characterStyleName = name; m_flags |= wxTEXT_ATTR_CHARACTER_STYLE_NAME; }
 329     void SetParagraphStyleName(const wxString& name) { m_paragraphStyleName = name; m_flags |= wxTEXT_ATTR_PARAGRAPH_STYLE_NAME; }
 330     void SetListStyleName(const wxString& name) { m_listStyleName = name; SetFlags(GetFlags() | wxTEXT_ATTR_LIST_STYLE_NAME); }
 331     void SetParagraphSpacingAfter(int spacing) { m_paragraphSpacingAfter = spacing; m_flags |= wxTEXT_ATTR_PARA_SPACING_AFTER; }
 332     void SetParagraphSpacingBefore(int spacing) { m_paragraphSpacingBefore = spacing; m_flags |= wxTEXT_ATTR_PARA_SPACING_BEFORE; }
 333     void SetLineSpacing(int spacing) { m_lineSpacing = spacing; m_flags |= wxTEXT_ATTR_LINE_SPACING; }
 334     void SetBulletStyle(int style) { m_bulletStyle = style; m_flags |= wxTEXT_ATTR_BULLET_STYLE; }
 335     void SetBulletNumber(int n) { m_bulletNumber = n; m_flags |= wxTEXT_ATTR_BULLET_NUMBER; }
 336     void SetBulletText(const wxString& text) { m_bulletText = text; m_flags |= wxTEXT_ATTR_BULLET_TEXT; }
 337     void SetBulletFont(const wxString& bulletFont) { m_bulletFont = bulletFont; }
 338     void SetBulletName(const wxString& name) { m_bulletName = name; m_flags |= wxTEXT_ATTR_BULLET_NAME; }
 339     void SetURL(const wxString& url) { m_urlTarget = url; m_flags |= wxTEXT_ATTR_URL; }
 340     void SetPageBreak(bool pageBreak = true) { SetFlags(pageBreak ? (GetFlags() | wxTEXT_ATTR_PAGE_BREAK) : (GetFlags() & ~wxTEXT_ATTR_PAGE_BREAK)); }
 341     void SetTextEffects(int effects) { m_textEffects = effects; SetFlags(GetFlags() | wxTEXT_ATTR_EFFECTS); }
 342     void SetTextEffectFlags(int effects) { m_textEffectFlags = effects; }
 343     void SetOutlineLevel(int level) { m_outlineLevel = level; SetFlags(GetFlags() | wxTEXT_ATTR_OUTLINE_LEVEL); }
 344
 345     const wxColour& GetTextColour() const { return m_colText; }
 346     const wxColour& GetBackgroundColour() const { return m_colBack; }
 347     wxTextAttrAlignment GetAlignment() const { return m_textAlignment; }
 348     const wxArrayInt& GetTabs() const { return m_tabs; }
 349     long GetLeftIndent() const { return m_leftIndent; }
 350     long GetLeftSubIndent() const { return m_leftSubIndent; }
 351     long GetRightIndent() const { return m_rightIndent; }
 352     long GetFlags() const { return m_flags; }
 353
 354     int GetFontSize() const { return m_fontSize; }
 355     wxFontStyle GetFontStyle() const { return m_fontStyle; }
 356     wxFontWeight GetFontWeight() const { return m_fontWeight; }
 357     bool GetFontUnderlined() const { return m_fontUnderlined; }
 358     const wxString& GetFontFaceName() const { return m_fontFaceName; }
 359     wxFontEncoding GetFontEncoding() const { return m_fontEncoding; }
 360     wxFontFamily GetFontFamily() const { return m_fontFamily; }
 361
 362     wxFont GetFont() const;
 363
 364     const wxString& GetCharacterStyleName() const { return m_characterStyleName; }
 365     const wxString& GetParagraphStyleName() const { return m_paragraphStyleName; }
 366     const wxString& GetListStyleName() const { return m_listStyleName; }
 367     int GetParagraphSpacingAfter() const { return m_paragraphSpacingAfter; }
 368     int GetParagraphSpacingBefore() const { return m_paragraphSpacingBefore; }
 369
 370     int GetLineSpacing() const { return m_lineSpacing; }
 371     int GetBulletStyle() const { return m_bulletStyle; }
 372     int GetBulletNumber() const { return m_bulletNumber; }
 373     const wxString& GetBulletText() const { return m_bulletText; }
 374     const wxString& GetBulletFont() const { return m_bulletFont; }
 375     const wxString& GetBulletName() const { return m_bulletName; }
 376     const wxString& GetURL() const { return m_urlTarget; }
 377     int GetTextEffects() const { return m_textEffects; }
 378     int GetTextEffectFlags() const { return m_textEffectFlags; }
 379     int GetOutlineLevel() const { return m_outlineLevel; }
 380
 381     // accessors
 382     bool HasTextColour() const { return m_colText.Ok() && HasFlag(wxTEXT_ATTR_TEXT_COLOUR) ; }
 383     bool HasBackgroundColour() const { return m_colBack.Ok() && HasFlag(wxTEXT_ATTR_BACKGROUND_COLOUR) ; }
 384     bool HasAlignment() const { return (m_textAlignment != wxTEXT_ALIGNMENT_DEFAULT) && HasFlag(wxTEXT_ATTR_ALIGNMENT) ; }
 385     bool HasTabs() const { return HasFlag(wxTEXT_ATTR_TABS) ; }
 386     bool HasLeftIndent() const { return HasFlag(wxTEXT_ATTR_LEFT_INDENT); }
 387     bool HasRightIndent() const { return HasFlag(wxTEXT_ATTR_RIGHT_INDENT); }
 388     bool HasFontWeight() const { return HasFlag(wxTEXT_ATTR_FONT_WEIGHT); }
 389     bool HasFontSize() const { return HasFlag(wxTEXT_ATTR_FONT_SIZE); }
 390     bool HasFontItalic() const { return HasFlag(wxTEXT_ATTR_FONT_ITALIC); }
 391     bool HasFontUnderlined() const { return HasFlag(wxTEXT_ATTR_FONT_UNDERLINE); }
 392     bool HasFontFaceName() const { return HasFlag(wxTEXT_ATTR_FONT_FACE); }
 393     bool HasFontEncoding() const { return HasFlag(wxTEXT_ATTR_FONT_ENCODING); }
 394     bool HasFontFamily() const { return HasFlag(wxTEXT_ATTR_FONT_FAMILY); }
 395     bool HasFont() const { return HasFlag(wxTEXT_ATTR_FONT); }
 396
 397     bool HasParagraphSpacingAfter() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_AFTER); }
 398     bool HasParagraphSpacingBefore() const { return HasFlag(wxTEXT_ATTR_PARA_SPACING_BEFORE); }
 399     bool HasLineSpacing() const { return HasFlag(wxTEXT_ATTR_LINE_SPACING); }
 400     bool HasCharacterStyleName() const { return HasFlag(wxTEXT_ATTR_CHARACTER_STYLE_NAME) && !m_characterStyleName.IsEmpty(); }
 401     bool HasParagraphStyleName() const { return HasFlag(wxTEXT_ATTR_PARAGRAPH_STYLE_NAME) && !m_paragraphStyleName.IsEmpty(); }
 402     bool HasListStyleName() const { return HasFlag(wxTEXT_ATTR_LIST_STYLE_NAME) || !m_listStyleName.IsEmpty(); }
 403     bool HasBulletStyle() const { return HasFlag(wxTEXT_ATTR_BULLET_STYLE); }
 404     bool HasBulletNumber() const { return HasFlag(wxTEXT_ATTR_BULLET_NUMBER); }
 405     bool HasBulletText() const { return HasFlag(wxTEXT_ATTR_BULLET_TEXT); }
 406     bool HasBulletName() const { return HasFlag(wxTEXT_ATTR_BULLET_NAME); }
 407     bool HasURL() const { return HasFlag(wxTEXT_ATTR_URL); }
 408     bool HasPageBreak() const { return HasFlag(wxTEXT_ATTR_PAGE_BREAK); }
 409     bool HasTextEffects() const { return HasFlag(wxTEXT_ATTR_EFFECTS); }
 410     bool HasTextEffect(int effect) const { return HasFlag(wxTEXT_ATTR_EFFECTS) && ((GetTextEffectFlags() & effect) != 0); }
 411     bool HasOutlineLevel() const { return HasFlag(wxTEXT_ATTR_OUTLINE_LEVEL); }
 412
 413     bool HasFlag(long flag) const { return (m_flags & flag) != 0; }
 414
 415     // Is this a character style?
 416     bool IsCharacterStyle() const { return HasFlag(wxTEXT_ATTR_CHARACTER); }
 417     bool IsParagraphStyle() const { return HasFlag(wxTEXT_ATTR_PARAGRAPH); }
 418
 419     // returns false if we have any attributes set, true otherwise
 420     bool IsDefault() const
 421     {
 422         return GetFlags() == 0;
 423     }
 424
 425     // Merges the given attributes. Does not affect 'this'. If compareWith
 426     // is non-NULL, then it will be used to mask out those attributes that are the same in style
 427     // and compareWith, for situations where we don't want to explicitly set inherited attributes.
 428     bool Apply(const wxTextAttr& style, const wxTextAttr* compareWith = NULL);
 429
 430     // merges the attributes of the base and the overlay objects and returns
 431     // the result; the parameter attributes take precedence
 432     //
 433     // WARNING: the order of arguments is the opposite of Combine()
 434     static wxTextAttr Merge(const wxTextAttr& base, const wxTextAttr& overlay)
 435     {
 436         return Combine(overlay, base, NULL);
 437     }
 438
 439     // merges the attributes of this object and overlay
 440     void Merge(const wxTextAttr& overlay)
 441     {
 442         *this = Merge(*this, overlay);
 443     }
 444
 445     // return the attribute having the valid font and colours: it uses the
 446     // attributes set in attr and falls back first to attrDefault and then to
 447     // the text control font/colours for those attributes which are not set
 448     static wxTextAttr Combine(const wxTextAttr& attr,
 449                               const wxTextAttr& attrDef,
 450                               const wxTextCtrlBase *text);
 451
 452     // Compare tabs
 453     static bool TabsEq(const wxArrayInt& tabs1, const wxArrayInt& tabs2);
 454
 455     // Remove attributes
 456     static bool RemoveStyle(wxTextAttr& destStyle, const wxTextAttr& style);
 457
 458     // Combine two bitlists, specifying the bits of interest with separate flags.
 459     static bool CombineBitlists(int& valueA, int valueB, int& flagsA, int flagsB);
 460
 461     // Compare two bitlists
 462     static bool BitlistsEqPartial(int valueA, int valueB, int flags);
 463
 464     // Split into paragraph and character styles
 465     static bool SplitParaCharStyles(const wxTextAttr& style, wxTextAttr& parStyle, wxTextAttr& charStyle);
 466
 467 private:
 468     long                m_flags;
 469
 470     // Paragraph styles
 471     wxArrayInt          m_tabs; // array of int: tab stops in 1/10 mm
 472     int                 m_leftIndent; // left indent in 1/10 mm
 473     int                 m_leftSubIndent; // left indent for all but the first
 474                                          // line in a paragraph relative to the
 475                                          // first line, in 1/10 mm
 476     int                 m_rightIndent; // right indent in 1/10 mm
 477     wxTextAttrAlignment m_textAlignment;
 478
 479     int                 m_paragraphSpacingAfter;
 480     int                 m_paragraphSpacingBefore;
 481     int                 m_lineSpacing;
 482     int                 m_bulletStyle;
 483     int                 m_bulletNumber;
 484     int                 m_textEffects;
 485     int                 m_textEffectFlags;
 486     int                 m_outlineLevel;
 487     wxString            m_bulletText;
 488     wxString            m_bulletFont;
 489     wxString            m_bulletName;
 490     wxString            m_urlTarget;
 491     wxFontEncoding      m_fontEncoding;
 492
 493     // Character styles
 494     wxColour            m_colText,
 495                         m_colBack;
 496     int                 m_fontSize;
 497     wxFontStyle         m_fontStyle;
 498     wxFontWeight        m_fontWeight;
 499     wxFontFamily        m_fontFamily;
 500     bool                m_fontUnderlined;
 501     wxString            m_fontFaceName;
 502
 503     // Character style
 504     wxString            m_characterStyleName;
 505
 506     // Paragraph style
 507     wxString            m_paragraphStyleName;
 508
 509     // List style
 510     wxString            m_listStyleName;
 511 };
 512
 513 // ----------------------------------------------------------------------------
 514 // wxTextAreaBase: multiline text control specific methods
 515 // ----------------------------------------------------------------------------
 516
 517 class WXDLLIMPEXP_CORE wxTextAreaBase
 518 {
 519 public:
 520     wxTextAreaBase() { }
 521     virtual ~wxTextAreaBase() { }
 522
 523     // lines access
 524     // ------------
 525
 526     virtual int GetLineLength(long lineNo) const = 0;
 527     virtual wxString GetLineText(long lineNo) const = 0;
 528     virtual int GetNumberOfLines() const = 0;
 529
 530
 531     // file IO
 532     // -------
 533
 534     bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY)
 535         { return DoLoadFile(file, fileType); }
 536     bool SaveFile(const wxString& file = wxEmptyString,
 537                   int fileType = wxTEXT_TYPE_ANY);
 538
 539     // dirty flag handling
 540     // -------------------
 541
 542     virtual bool IsModified() const = 0;
 543     virtual void MarkDirty() = 0;
 544     virtual void DiscardEdits() = 0;
 545     void SetModified(bool modified)
 546     {
 547         if ( modified )
 548             MarkDirty();
 549         else
 550             DiscardEdits();
 551     }
 552
 553
 554     // styles handling
 555     // ---------------
 556
 557     // text control under some platforms supports the text styles: these
 558     // methods allow to apply the given text style to the given selection or to
 559     // set/get the style which will be used for all appended text
 560     virtual bool SetStyle(long start, long end, const wxTextAttr& style) = 0;
 561     virtual bool GetStyle(long position, wxTextAttr& style) = 0;
 562     virtual bool SetDefaultStyle(const wxTextAttr& style) = 0;
 563     virtual const wxTextAttr& GetDefaultStyle() const { return m_defaultStyle; }
 564
 565
 566     // coordinates translation
 567     // -----------------------
 568
 569     // translate between the position (which is just an index in the text ctrl
 570     // considering all its contents as a single strings) and (x, y) coordinates
 571     // which represent column and line.
 572     virtual long XYToPosition(long x, long y) const = 0;
 573     virtual bool PositionToXY(long pos, long *x, long *y) const = 0;
 574
 575     virtual void ShowPosition(long pos) = 0;
 576
 577     // find the character at position given in pixels
 578     //
 579     // NB: pt is in device coords (not adjusted for the client area origin nor
 580     //     scrolling)
 581     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
 582     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 583                                             wxTextCoord *col,
 584                                             wxTextCoord *row) const;
 585     virtual wxString GetValue() const = 0;
 586     virtual void SetValue(const wxString& value) = 0;
 587
 588 protected:
 589     // implementation of loading/saving
 590     virtual bool DoLoadFile(const wxString& file, int fileType);
 591     virtual bool DoSaveFile(const wxString& file, int fileType);
 592
 593
 594     // the name of the last file loaded with LoadFile() which will be used by
 595     // SaveFile() by default
 596     wxString m_filename;
 597
 598     // the text style which will be used for any new text added to the control
 599     wxTextAttr m_defaultStyle;
 600
 601
 602     wxDECLARE_NO_COPY_CLASS(wxTextAreaBase);
 603 };
 604
 605 // this class defines wxTextCtrl interface, wxTextCtrlBase actually implements
 606 // too much things because it derives from wxTextEntry and not wxTextEntryBase
 607 // and so any classes which "look like" wxTextCtrl (such as wxRichTextCtrl)
 608 // but don't need the (native) implementation bits from wxTextEntry should
 609 // actually derive from this one and not wxTextCtrlBase
 610 class WXDLLIMPEXP_CORE wxTextCtrlIface : public wxTextAreaBase,
 611                                          public wxTextEntryBase
 612 {
 613 public:
 614     wxTextCtrlIface() { }
 615
 616     // wxTextAreaBase overrides
 617     virtual wxString GetValue() const
 618     {
 619        return wxTextEntryBase::GetValue();
 620     }
 621     virtual void SetValue(const wxString& value)
 622     {
 623        wxTextEntryBase::SetValue(value);
 624     }
 625
 626 private:
 627     wxDECLARE_NO_COPY_CLASS(wxTextCtrlIface);
 628 };
 629
 630 // ----------------------------------------------------------------------------
 631 // wxTextCtrl: a single or multiple line text zone where user can edit text
 632 // ----------------------------------------------------------------------------
 633
 634 class WXDLLIMPEXP_CORE wxTextCtrlBase : public wxControl,
 635 #if wxHAS_TEXT_WINDOW_STREAM
 636                                    public wxSTD streambuf,
 637 #endif
 638                                    public wxTextAreaBase,
 639                                    public wxTextEntry
 640 {
 641 public:
 642     // creation
 643     // --------
 644
 645     wxTextCtrlBase() { }
 646     virtual ~wxTextCtrlBase() { }
 647
 648
 649     // more readable flag testing methods
 650     bool IsSingleLine() const { return !HasFlag(wxTE_MULTILINE); }
 651     bool IsMultiLine() const { return !IsSingleLine(); }
 652
 653     // stream-like insertion operators: these are always available, whether we
 654     // were, or not, compiled with streambuf support
 655     wxTextCtrl& operator<<(const wxString& s);
 656     wxTextCtrl& operator<<(int i);
 657     wxTextCtrl& operator<<(long i);
 658     wxTextCtrl& operator<<(float f) { return *this << double(f); }
 659     wxTextCtrl& operator<<(double d);
 660     wxTextCtrl& operator<<(char c) { return *this << wxString(c); }
 661     wxTextCtrl& operator<<(wchar_t c) { return *this << wxString(c); }
 662
 663     // insert the character which would have resulted from this key event,
 664     // return true if anything has been inserted
 665     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 666
 667
 668     // generate the wxEVT_COMMAND_TEXT_UPDATED event, like SetValue() does and
 669     // return true if the event was processed
 670     static bool SendTextUpdatedEvent(wxWindow *win);
 671     bool SendTextUpdatedEvent() { return SendTextUpdatedEvent(this); }
 672
 673     // do the window-specific processing after processing the update event
 674     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
 675
 676     virtual bool ShouldInheritColours() const { return false; }
 677
 678     // work around the problem with having HitTest() both in wxControl and
 679     // wxTextAreaBase base classes
 680     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const
 681     {
 682         return wxTextAreaBase::HitTest(pt, pos);
 683     }
 684
 685     virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
 686                                             wxTextCoord *col,
 687                                             wxTextCoord *row) const
 688     {
 689         return wxTextAreaBase::HitTest(pt, col, row);
 690     }
 691
 692     // we provide stubs for these functions as not all platforms have styles
 693     // support, but we really should leave them pure virtual here
 694     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 695     virtual bool GetStyle(long position, wxTextAttr& style);
 696     virtual bool SetDefaultStyle(const wxTextAttr& style);
 697
 698     // wxTextAreaBase overrides
 699     virtual wxString GetValue() const
 700     {
 701        return wxTextEntry::GetValue();
 702     }
 703     virtual void SetValue(const wxString& value)
 704     {
 705        wxTextEntry::SetValue(value);
 706     }
 707
 708     // wxWindow overrides
 709     virtual wxVisualAttributes GetDefaultAttributes() const
 710     {
 711         return GetClassDefaultAttributes(GetWindowVariant());
 712     }
 713
 714     static wxVisualAttributes
 715     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
 716     {
 717         return GetCompositeControlsDefaultAttributes(variant);
 718     }
 719
 720 protected:
 721     // override streambuf method
 722 #if wxHAS_TEXT_WINDOW_STREAM
 723     int overflow(int i);
 724 #endif // wxHAS_TEXT_WINDOW_STREAM
 725
 726     virtual bool DoLoadFile(const wxString& file, int fileType);
 727     virtual bool DoSaveFile(const wxString& file, int fileType);
 728
 729     // implement the wxTextEntry pure virtual method
 730     virtual wxWindow *GetEditableWindow() { return this; }
 731
 732     wxDECLARE_NO_COPY_CLASS(wxTextCtrlBase);
 733     DECLARE_ABSTRACT_CLASS(wxTextCtrlBase)
 734 };
 735
 736 // ----------------------------------------------------------------------------
 737 // include the platform-dependent class definition
 738 // ----------------------------------------------------------------------------
 739
 740 #if defined(__WXX11__)
 741     #include "wx/x11/textctrl.h"
 742 #elif defined(__WXUNIVERSAL__)
 743     #include "wx/univ/textctrl.h"
 744 #elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
 745     #include "wx/msw/wince/textctrlce.h"
 746 #elif defined(__WXMSW__)
 747     #include "wx/msw/textctrl.h"
 748 #elif defined(__WXMOTIF__)
 749     #include "wx/motif/textctrl.h"
 750 #elif defined(__WXGTK20__)
 751     #include "wx/gtk/textctrl.h"
 752 #elif defined(__WXGTK__)
 753     #include "wx/gtk1/textctrl.h"
 754 #elif defined(__WXMAC__)
 755     #include "wx/osx/textctrl.h"
 756 #elif defined(__WXCOCOA__)
 757     #include "wx/cocoa/textctrl.h"
 758 #elif defined(__WXPM__)
 759     #include "wx/os2/textctrl.h"
 760 #elif defined(__WXPALMOS__)
 761     #include "wx/palmos/textctrl.h"
 762 #endif
 763
 764 // ----------------------------------------------------------------------------
 765 // wxTextCtrl events
 766 // ----------------------------------------------------------------------------
 767
 768 class WXDLLIMPEXP_FWD_CORE wxTextUrlEvent;
 769
 770 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_UPDATED, wxCommandEvent);
 771 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_ENTER, wxCommandEvent);
 772 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_URL, wxTextUrlEvent);
 773 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_TEXT_MAXLEN, wxCommandEvent);
 774
 775 class WXDLLIMPEXP_CORE wxTextUrlEvent : public wxCommandEvent
 776 {
 777 public:
 778     wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
 779                    long start, long end)
 780         : wxCommandEvent(wxEVT_COMMAND_TEXT_URL, winid),
 781           m_evtMouse(evtMouse), m_start(start), m_end(end)
 782         { }
 783     wxTextUrlEvent(const wxTextUrlEvent& event)
 784         : wxCommandEvent(event),
 785           m_evtMouse(event.m_evtMouse),
 786           m_start(event.m_start),
 787           m_end(event.m_end) { }
 788
 789     // get the mouse event which happend over the URL
 790     const wxMouseEvent& GetMouseEvent() const { return m_evtMouse; }
 791
 792     // get the start of the URL
 793     long GetURLStart() const { return m_start; }
 794
 795     // get the end of the URL
 796     long GetURLEnd() const { return m_end; }
 797
 798     virtual wxEvent *Clone() const { return new wxTextUrlEvent(*this); }
 799
 800 protected:
 801     // the corresponding mouse event
 802     wxMouseEvent m_evtMouse;
 803
 804     // the start and end indices of the URL in the text control
 805     long m_start,
 806          m_end;
 807
 808 private:
 809     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxTextUrlEvent)
 810
 811 public:
 812     // for wxWin RTTI only, don't use
 813     wxTextUrlEvent() : m_evtMouse(), m_start(0), m_end(0) { }
 814 };
 815
 816 typedef void (wxEvtHandler::*wxTextUrlEventFunction)(wxTextUrlEvent&);
 817
 818 #define wxTextEventHandler(func) wxCommandEventHandler(func)
 819 #define wxTextUrlEventHandler(func) \
 820     wxEVENT_HANDLER_CAST(wxTextUrlEventFunction, func)
 821
 822 #define wx__DECLARE_TEXTEVT(evt, id, fn) \
 823     wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextEventHandler(fn))
 824
 825 #define wx__DECLARE_TEXTURLEVT(evt, id, fn) \
 826     wx__DECLARE_EVT1(wxEVT_COMMAND_TEXT_ ## evt, id, wxTextUrlEventHandler(fn))
 827
 828 #define EVT_TEXT(id, fn) wx__DECLARE_TEXTEVT(UPDATED, id, fn)
 829 #define EVT_TEXT_ENTER(id, fn) wx__DECLARE_TEXTEVT(ENTER, id, fn)
 830 #define EVT_TEXT_URL(id, fn) wx__DECLARE_TEXTURLEVT(URL, id, fn)
 831 #define EVT_TEXT_MAXLEN(id, fn) wx__DECLARE_TEXTEVT(MAXLEN, id, fn)
 832
 833 #if wxHAS_TEXT_WINDOW_STREAM
 834
 835 // ----------------------------------------------------------------------------
 836 // wxStreamToTextRedirector: this class redirects all data sent to the given
 837 // C++ stream to the wxTextCtrl given to its ctor during its lifetime.
 838 // ----------------------------------------------------------------------------
 839
 840 class WXDLLIMPEXP_CORE wxStreamToTextRedirector
 841 {
 842 private:
 843     void Init(wxTextCtrl *text)
 844     {
 845         m_sbufOld = m_ostr.rdbuf();
 846         m_ostr.rdbuf(text);
 847     }
 848
 849 public:
 850     wxStreamToTextRedirector(wxTextCtrl *text)
 851         : m_ostr(wxSTD cout)
 852     {
 853         Init(text);
 854     }
 855
 856     wxStreamToTextRedirector(wxTextCtrl *text, wxSTD ostream *ostr)
 857         : m_ostr(*ostr)
 858     {
 859         Init(text);
 860     }
 861
 862     ~wxStreamToTextRedirector()
 863     {
 864         m_ostr.rdbuf(m_sbufOld);
 865     }
 866
 867 private:
 868     // the stream we're redirecting
 869     wxSTD ostream&   m_ostr;
 870
 871     // the old streambuf (before we changed it)
 872     wxSTD streambuf *m_sbufOld;
 873 };
 874
 875 #endif // wxHAS_TEXT_WINDOW_STREAM
 876
 877 #endif // wxUSE_TEXTCTRL
 878
 879 #endif
 880     // _WX_TEXTCTRL_H_BASE_