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