include/wx/textctrl.h

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