wxPython/src/_textctrl.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _textctrl.i
   3 // Purpose:     SWIG interface defs for wxTextCtrl and related classes
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     10-June-1998
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17
  18 MAKE_CONST_WXSTRING(TextCtrlNameStr);
  19
  20 //---------------------------------------------------------------------------
  21 %newgroup
  22
  23 enum {
  24     // Style flags
  25     wxTE_NO_VSCROLL,
  26     wxTE_AUTO_SCROLL,
  27
  28     wxTE_READONLY,
  29     wxTE_MULTILINE,
  30     wxTE_PROCESS_TAB,
  31
  32     // alignment flags
  33     wxTE_LEFT,
  34     wxTE_CENTER,
  35     wxTE_RIGHT,
  36     wxTE_CENTRE,
  37
  38     // this style means to use RICHEDIT control and does something only under
  39     // wxMSW and Win32 and is silently ignored under all other platforms
  40     wxTE_RICH,
  41
  42     wxTE_PROCESS_ENTER,
  43     wxTE_PASSWORD,
  44
  45     // automatically detect the URLs and generate the events when mouse is
  46     // moved/clicked over an URL
  47     //
  48     // this is for Win32 richedit controls only so far
  49     wxTE_AUTO_URL,
  50
  51     // by default, the Windows text control doesn't show the selection when it
  52     // doesn't have focus - use this style to force it to always show it
  53     wxTE_NOHIDESEL,
  54
  55     // use wxHSCROLL (wxTE_DONTWRAP) to not wrap text at all, wxTE_CHARWRAP to
  56     // wrap it at any position and wxTE_WORDWRAP to wrap at words boundary
  57     //
  58     // if no wrapping style is given at all, the control wraps at word boundary
  59     wxTE_DONTWRAP,
  60     wxTE_CHARWRAP,
  61     wxTE_WORDWRAP,
  62     wxTE_BESTWRAP,
  63
  64     // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
  65     // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
  66     wxTE_RICH2,
  67
  68     wxTE_CAPITALIZE,
  69 };
  70
  71 %pythoncode { TE_LINEWRAP = TE_CHARWRAP }
  72
  73
  74
  75 enum wxTextAttrAlignment
  76 {
  77     wxTEXT_ALIGNMENT_DEFAULT,
  78     wxTEXT_ALIGNMENT_LEFT,
  79     wxTEXT_ALIGNMENT_CENTRE,
  80     wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
  81     wxTEXT_ALIGNMENT_RIGHT,
  82     wxTEXT_ALIGNMENT_JUSTIFIED
  83 };
  84
  85 enum {
  86     // Flags to indicate which attributes are being applied
  87     wxTEXT_ATTR_TEXT_COLOUR,
  88     wxTEXT_ATTR_BACKGROUND_COLOUR,
  89     wxTEXT_ATTR_FONT_FACE,
  90     wxTEXT_ATTR_FONT_SIZE,
  91     wxTEXT_ATTR_FONT_WEIGHT,
  92     wxTEXT_ATTR_FONT_ITALIC,
  93     wxTEXT_ATTR_FONT_UNDERLINE,
  94     wxTEXT_ATTR_FONT,
  95     wxTEXT_ATTR_ALIGNMENT,
  96     wxTEXT_ATTR_LEFT_INDENT,
  97     wxTEXT_ATTR_RIGHT_INDENT,
  98     wxTEXT_ATTR_TABS
  99 };
 100
 101 enum wxTextCtrlHitTestResult
 102 {
 103     wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
 104     wxTE_HT_BEFORE,         // either to the left or upper
 105     wxTE_HT_ON_TEXT,        // directly on
 106     wxTE_HT_BELOW,          // below [the last line]
 107     wxTE_HT_BEYOND          // after [the end of line]
 108 };
 109
 110
 111 enum {
 112     wxOutOfRangeTextCoord,
 113     wxInvalidTextCoord,
 114
 115     wxTEXT_TYPE_ANY
 116 };
 117
 118 //---------------------------------------------------------------------------
 119
 120 // wxTextAttr: a structure containing the visual attributes of a text
 121 class wxTextAttr
 122 {
 123 public:
 124     wxTextAttr(const wxColour& colText = wxNullColour,
 125                const wxColour& colBack = wxNullColour,
 126                const wxFont& font = wxNullFont,
 127                wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
 128     ~wxTextAttr();
 129
 130     // operations
 131     void Init();
 132
 133     // merges the attributes of the base and the overlay objects and returns
 134     // the result; the parameter attributes take precedence
 135     //
 136     // WARNING: the order of arguments is the opposite of Combine()
 137     static wxTextAttr Merge(const wxTextAttr& base, const wxTextAttr& overlay);
 138
 139 //     // merges the attributes of this object and overlay
 140 //     void Merge(const wxTextAttr& overlay);
 141
 142
 143     // setters
 144     void SetTextColour(const wxColour& colText);
 145     void SetBackgroundColour(const wxColour& colBack);
 146     void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT);
 147     void SetAlignment(wxTextAttrAlignment alignment);
 148     void SetTabs(const wxArrayInt& tabs);
 149     void SetLeftIndent(int indent, int subIndent=0);
 150     void SetRightIndent(int indent);
 151     void SetFlags(long flags);
 152
 153     // accessors
 154     bool HasTextColour() const;
 155     bool HasBackgroundColour() const;
 156     bool HasFont() const;
 157     bool HasAlignment() const;
 158     bool HasTabs() const;
 159     bool HasLeftIndent() const;
 160     bool HasRightIndent() const;
 161     bool HasFlag(long flag) const;
 162
 163     const wxColour& GetTextColour() const;
 164     const wxColour& GetBackgroundColour() const;
 165     const wxFont& GetFont() const;
 166     wxTextAttrAlignment GetAlignment() const;
 167     const wxArrayInt& GetTabs() const;
 168     long GetLeftIndent() const;
 169     long GetLeftSubIndent() const;
 170     long GetRightIndent() const;
 171     long GetFlags() const;
 172
 173     // returns False if we have any attributes set, True otherwise
 174     bool IsDefault() const;
 175
 176     // return the attribute having the valid font and colours: it uses the
 177     // attributes set in attr and falls back first to attrDefault and then to
 178     // the text control font/colours for those attributes which are not set
 179     static wxTextAttr Combine(const wxTextAttr& attr,
 180                               const wxTextAttr& attrDef,
 181                               const wxTextCtrl *text);
 182
 183     %property(Alignment, GetAlignment, SetAlignment, doc="See `GetAlignment` and `SetAlignment`");
 184     %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
 185     %property(Flags, GetFlags, SetFlags, doc="See `GetFlags` and `SetFlags`");
 186     %property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
 187     %property(LeftIndent, GetLeftIndent, SetLeftIndent, doc="See `GetLeftIndent` and `SetLeftIndent`");
 188     %property(LeftSubIndent, GetLeftSubIndent, doc="See `GetLeftSubIndent`");
 189     %property(RightIndent, GetRightIndent, SetRightIndent, doc="See `GetRightIndent` and `SetRightIndent`");
 190     %property(Tabs, GetTabs, SetTabs, doc="See `GetTabs` and `SetTabs`");
 191     %property(TextColour, GetTextColour, SetTextColour, doc="See `GetTextColour` and `SetTextColour`");
 192 };
 193
 194 //---------------------------------------------------------------------------
 195
 196 // wxTextCtrl: a single or multiple line text zone where user can enter and
 197 // edit text
 198 MustHaveApp(wxTextCtrl);
 199 class wxTextCtrl : public wxControl
 200 {
 201 public:
 202     %pythonAppend wxTextCtrl         "self._setOORInfo(self)"
 203     %pythonAppend wxTextCtrl()       ""
 204     %typemap(out) wxTextCtrl*;    // turn off this typemap
 205
 206     wxTextCtrl(wxWindow* parent, wxWindowID id=-1,
 207                const wxString& value = wxPyEmptyString,
 208                const wxPoint& pos = wxDefaultPosition,
 209                const wxSize& size = wxDefaultSize,
 210                long style = 0,
 211                const wxValidator& validator = wxDefaultValidator,
 212                const wxString& name = wxPyTextCtrlNameStr);
 213     %RenameCtor(PreTextCtrl, wxTextCtrl());
 214
 215     // Turn it back on again
 216     %typemap(out) wxTextCtrl* { $result = wxPyMake_wxObject($1, $owner); }
 217
 218     bool Create(wxWindow* parent, wxWindowID id=-1,
 219                const wxString& value = wxPyEmptyString,
 220                const wxPoint& pos = wxDefaultPosition,
 221                const wxSize& size = wxDefaultSize,
 222                long style = 0,
 223                const wxValidator& validator = wxDefaultValidator,
 224                const wxString& name = wxPyTextCtrlNameStr);
 225
 226
 227     virtual wxString GetValue() const;
 228     virtual void SetValue(const wxString& value);
 229
 230     virtual wxString GetRange(long from, long to) const;
 231
 232     virtual int GetLineLength(long lineNo) const;
 233     virtual wxString GetLineText(long lineNo) const;
 234     virtual int GetNumberOfLines() const;
 235
 236     virtual bool IsModified() const;
 237     virtual bool IsEditable() const;
 238
 239     // more readable flag testing methods
 240     bool IsSingleLine() const;
 241     bool IsMultiLine() const;
 242
 243
 244     DocDeclAStr(
 245         virtual void, GetSelection(long* OUTPUT, long* OUTPUT) const,
 246         "GetSelection() -> (from, to)",
 247         "If the return values from and to are the same, there is no selection.", "");
 248
 249     virtual wxString GetStringSelection() const;
 250
 251
 252     // editing
 253     virtual void Clear();
 254     virtual void Replace(long from, long to, const wxString& value);
 255     virtual void Remove(long from, long to);
 256
 257     // load/save the controls contents from/to the file
 258     virtual bool LoadFile(const wxString& file, int fileType = wxTEXT_TYPE_ANY);
 259     virtual bool SaveFile(const wxString& file = wxPyEmptyString, int fileType = wxTEXT_TYPE_ANY);
 260
 261     // sets/clears the dirty flag
 262     virtual void MarkDirty();
 263     virtual void DiscardEdits();
 264     void SetModified(bool modified);
 265
 266     // set the max number of characters which may be entered in a single line
 267     // text control
 268     virtual void SetMaxLength(unsigned long len);
 269
 270     // writing text inserts it at the current position, appending always
 271     // inserts it at the end
 272     virtual void WriteText(const wxString& text);
 273     virtual void AppendText(const wxString& text);
 274
 275     // insert the character which would have resulted from this key event,
 276     // return True if anything has been inserted
 277     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 278
 279     // text control under some platforms supports the text styles: these
 280     // methods allow to apply the given text style to the given selection or to
 281     // set/get the style which will be used for all appended text
 282     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 283     virtual bool GetStyle(long position, wxTextAttr& style);
 284     virtual bool SetDefaultStyle(const wxTextAttr& style);
 285     virtual const wxTextAttr& GetDefaultStyle() const;
 286
 287     // translate between the position (which is just an index in the text ctrl
 288     // considering all its contents as a single strings) and (x, y) coordinates
 289     // which represent column and line.
 290     virtual long XYToPosition(long x, long y) const;
 291     DocDeclA(
 292         virtual /*bool*/ void, PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const,
 293         "PositionToXY(long pos) -> (x, y)");
 294
 295     virtual void ShowPosition(long pos);
 296
 297
 298     DocDeclAStr(
 299         virtual wxTextCtrlHitTestResult, HitTest(const wxPoint& pt,
 300                                                  long* OUTPUT, long* OUTPUT) const,
 301         "HitTest(Point pt) -> (result, col, row)",
 302         "Find the row, col coresponding to the character at the point given in
 303 pixels. NB: pt is in device coords but is not adjusted for the client
 304 area origin nor scrolling.", "");
 305
 306
 307     DocDeclAStrName(
 308         virtual wxTextCtrlHitTestResult , HitTest(const wxPoint& pt, long *OUTPUT) const,
 309         "HitTestPos(Point pt) -> (result, position)",
 310         "Find the character position in the text coresponding to the point
 311 given in pixels. NB: pt is in device coords but is not adjusted for
 312 the client area origin nor scrolling. ", "",
 313         HitTestPos);
 314
 315
 316
 317     // Clipboard operations
 318     virtual void Copy();
 319     virtual void Cut();
 320     virtual void Paste();
 321
 322     virtual bool CanCopy() const;
 323     virtual bool CanCut() const;
 324     virtual bool CanPaste() const;
 325
 326     // Undo/redo
 327     virtual void Undo();
 328     virtual void Redo();
 329
 330     virtual bool CanUndo() const;
 331     virtual bool CanRedo() const;
 332
 333     // Insertion point
 334     virtual void SetInsertionPoint(long pos);
 335     virtual void SetInsertionPointEnd();
 336     virtual long GetInsertionPoint() const;
 337     virtual long GetLastPosition() const;
 338
 339     virtual void SetSelection(long from, long to);
 340     virtual void SelectAll();
 341     virtual void SetEditable(bool editable);
 342
 343 #ifdef __WXMSW__
 344     // Caret handling (Windows only)
 345     bool ShowNativeCaret(bool show = true);
 346     bool HideNativeCaret();
 347 #endif
 348
 349     %extend {
 350         // TODO: Add more file-like methods
 351         void write(const wxString& text) {
 352             self->AppendText(text);
 353         }
 354     }
 355
 356     // TODO: replace this when the method is really added to wxTextCtrl
 357     %extend {
 358         wxString GetString(long from, long to) {
 359             return self->GetValue().Mid(from, to - from);
 360         }
 361     }
 362
 363     static wxVisualAttributes
 364     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 365
 366     %property(DefaultStyle, GetDefaultStyle, SetDefaultStyle, doc="See `GetDefaultStyle` and `SetDefaultStyle`");
 367     %property(InsertionPoint, GetInsertionPoint, SetInsertionPoint, doc="See `GetInsertionPoint` and `SetInsertionPoint`");
 368     %property(LastPosition, GetLastPosition, doc="See `GetLastPosition`");
 369     %property(NumberOfLines, GetNumberOfLines, doc="See `GetNumberOfLines`");
 370     %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
 371     %property(StringSelection, GetStringSelection, doc="See `GetStringSelection`");
 372     %property(Value, GetValue, SetValue, doc="See `GetValue` and `SetValue`");
 373 };
 374
 375 //---------------------------------------------------------------------------
 376
 377
 378 %constant wxEventType wxEVT_COMMAND_TEXT_UPDATED;
 379 %constant wxEventType wxEVT_COMMAND_TEXT_ENTER;
 380 %constant wxEventType wxEVT_COMMAND_TEXT_URL;
 381 %constant wxEventType wxEVT_COMMAND_TEXT_MAXLEN;
 382
 383
 384 class wxTextUrlEvent : public wxCommandEvent
 385 {
 386 public:
 387     wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
 388                    long start, long end);
 389
 390     // get the mouse event which happend over the URL
 391     const wxMouseEvent& GetMouseEvent();
 392
 393     // get the start of the URL
 394     long GetURLStart() const;
 395
 396     // get the end of the URL
 397     long GetURLEnd() const;
 398
 399     %property(MouseEvent, GetMouseEvent, doc="See `GetMouseEvent`");
 400     %property(URLEnd, GetURLEnd, doc="See `GetURLEnd`");
 401     %property(URLStart, GetURLStart, doc="See `GetURLStart`");
 402 };
 403
 404
 405 %pythoncode {
 406 EVT_TEXT        = wx.PyEventBinder( wxEVT_COMMAND_TEXT_UPDATED, 1)
 407 EVT_TEXT_ENTER  = wx.PyEventBinder( wxEVT_COMMAND_TEXT_ENTER, 1)
 408 EVT_TEXT_URL    = wx.PyEventBinder( wxEVT_COMMAND_TEXT_URL, 1)
 409 EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1)
 410 }
 411
 412
 413
 414
 415 //---------------------------------------------------------------------------
 416