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 to not wrap text at all, wxTE_LINEWRAP to wrap it at any
  56     // position and wxTE_WORDWRAP to wrap at words boundary
  57     wxTE_DONTWRAP,
  58     wxTE_LINEWRAP,
  59     wxTE_WORDWRAP,
  60
  61     // force using RichEdit version 2.0 or 3.0 instead of 1.0 (default) for
  62     // wxTE_RICH controls - can be used together with or instead of wxTE_RICH
  63     wxTE_RICH2,
  64 };
  65
  66
  67 enum wxTextAttrAlignment
  68 {
  69     wxTEXT_ALIGNMENT_DEFAULT,
  70     wxTEXT_ALIGNMENT_LEFT,
  71     wxTEXT_ALIGNMENT_CENTRE,
  72     wxTEXT_ALIGNMENT_CENTER = wxTEXT_ALIGNMENT_CENTRE,
  73     wxTEXT_ALIGNMENT_RIGHT,
  74     wxTEXT_ALIGNMENT_JUSTIFIED
  75 };
  76
  77 enum {
  78     // Flags to indicate which attributes are being applied
  79     wxTEXT_ATTR_TEXT_COLOUR,
  80     wxTEXT_ATTR_BACKGROUND_COLOUR,
  81     wxTEXT_ATTR_FONT_FACE,
  82     wxTEXT_ATTR_FONT_SIZE,
  83     wxTEXT_ATTR_FONT_WEIGHT,
  84     wxTEXT_ATTR_FONT_ITALIC,
  85     wxTEXT_ATTR_FONT_UNDERLINE,
  86     wxTEXT_ATTR_FONT,
  87     wxTEXT_ATTR_ALIGNMENT,
  88     wxTEXT_ATTR_LEFT_INDENT,
  89     wxTEXT_ATTR_RIGHT_INDENT,
  90     wxTEXT_ATTR_TABS
  91 };
  92
  93 enum wxTextCtrlHitTestResult
  94 {
  95     wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
  96     wxTE_HT_BEFORE,         // either to the left or upper
  97     wxTE_HT_ON_TEXT,        // directly on
  98     wxTE_HT_BELOW,          // below [the last line]
  99     wxTE_HT_BEYOND          // after [the end of line]
 100 };
 101
 102 //---------------------------------------------------------------------------
 103
 104 // wxTextAttr: a structure containing the visual attributes of a text
 105 class wxTextAttr
 106 {
 107 public:
 108     %nokwargs wxTextAttr;
 109     wxTextAttr();
 110     wxTextAttr(const wxColour& colText,
 111                const wxColour& colBack = wxNullColour,
 112                const wxFont& font = wxNullFont,
 113                wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
 114     ~wxTextAttr();
 115
 116     // operations
 117     void Init();
 118
 119     // setters
 120     void SetTextColour(const wxColour& colText);
 121     void SetBackgroundColour(const wxColour& colBack);
 122     void SetFont(const wxFont& font, long flags = wxTEXT_ATTR_FONT);
 123     void SetAlignment(wxTextAttrAlignment alignment);
 124     void SetTabs(const wxArrayInt& tabs);
 125     void SetLeftIndent(int indent, int subIndent=0);
 126     void SetRightIndent(int indent);
 127     void SetFlags(long flags);
 128
 129     // accessors
 130     bool HasTextColour() const;
 131     bool HasBackgroundColour() const;
 132     bool HasFont() const;
 133     bool HasAlignment() const;
 134     bool HasTabs() const;
 135     bool HasLeftIndent() const;
 136     bool HasRightIndent() const;
 137     bool HasFlag(long flag) const;
 138
 139     const wxColour& GetTextColour() const;
 140     const wxColour& GetBackgroundColour() const;
 141     const wxFont& GetFont() const;
 142     wxTextAttrAlignment GetAlignment() const;
 143     const wxArrayInt& GetTabs() const;
 144     long GetLeftIndent() const;
 145     long GetLeftSubIndent() const;
 146     long GetRightIndent() const;
 147     long GetFlags() const;
 148
 149     // returns False if we have any attributes set, True otherwise
 150     bool IsDefault() const;
 151
 152     // return the attribute having the valid font and colours: it uses the
 153     // attributes set in attr and falls back first to attrDefault and then to
 154     // the text control font/colours for those attributes which are not set
 155     static wxTextAttr Combine(const wxTextAttr& attr,
 156                               const wxTextAttr& attrDef,
 157                               const wxTextCtrl *text);
 158 };
 159
 160 //---------------------------------------------------------------------------
 161
 162 // wxTextCtrl: a single or multiple line text zone where user can enter and
 163 // edit text
 164 class wxTextCtrl : public wxControl
 165 {
 166 public:
 167     %pythonAppend wxTextCtrl         "self._setOORInfo(self)"
 168     %pythonAppend wxTextCtrl()       ""
 169
 170     wxTextCtrl(wxWindow* parent, wxWindowID id,
 171                const wxString& value = wxPyEmptyString,
 172                const wxPoint& pos = wxDefaultPosition,
 173                const wxSize& size = wxDefaultSize,
 174                long style = 0,
 175                const wxValidator& validator = wxDefaultValidator,
 176                const wxString& name = wxPyTextCtrlNameStr);
 177     %name(PreTextCtrl)wxTextCtrl();
 178
 179     bool Create(wxWindow* parent, wxWindowID id,
 180                const wxString& value = wxPyEmptyString,
 181                const wxPoint& pos = wxDefaultPosition,
 182                const wxSize& size = wxDefaultSize,
 183                long style = 0,
 184                const wxValidator& validator = wxDefaultValidator,
 185                const wxString& name = wxPyTextCtrlNameStr);
 186
 187
 188     virtual wxString GetValue() const;
 189     virtual void SetValue(const wxString& value);
 190
 191     virtual wxString GetRange(long from, long to) const;
 192
 193     virtual int GetLineLength(long lineNo) const;
 194     virtual wxString GetLineText(long lineNo) const;
 195     virtual int GetNumberOfLines() const;
 196
 197     virtual bool IsModified() const;
 198     virtual bool IsEditable() const;
 199
 200     // more readable flag testing methods
 201     bool IsSingleLine() const;
 202     bool IsMultiLine() const;
 203
 204
 205     DocDeclAStr(
 206         virtual void, GetSelection(long* OUTPUT, long* OUTPUT) const,
 207         "GetSelection() -> (from, to)",
 208         "If the return values from and to are the same, there is no selection.", "");
 209
 210     virtual wxString GetStringSelection() const;
 211
 212
 213     // editing
 214     virtual void Clear();
 215     virtual void Replace(long from, long to, const wxString& value);
 216     virtual void Remove(long from, long to);
 217
 218     // load/save the controls contents from/to the file
 219     virtual bool LoadFile(const wxString& file);
 220     virtual bool SaveFile(const wxString& file = wxPyEmptyString);
 221
 222     // sets/clears the dirty flag
 223     virtual void MarkDirty();
 224     virtual void DiscardEdits();
 225
 226     // set the max number of characters which may be entered in a single line
 227     // text control
 228     virtual void SetMaxLength(unsigned long len);
 229
 230     // writing text inserts it at the current position, appending always
 231     // inserts it at the end
 232     virtual void WriteText(const wxString& text);
 233     virtual void AppendText(const wxString& text);
 234
 235     // insert the character which would have resulted from this key event,
 236     // return True if anything has been inserted
 237     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 238
 239     // text control under some platforms supports the text styles: these
 240     // methods allow to apply the given text style to the given selection or to
 241     // set/get the style which will be used for all appended text
 242     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 243     virtual bool GetStyle(long position, wxTextAttr& style);
 244     virtual bool SetDefaultStyle(const wxTextAttr& style);
 245     virtual const wxTextAttr& GetDefaultStyle() const;
 246
 247     // translate between the position (which is just an index in the text ctrl
 248     // considering all its contents as a single strings) and (x, y) coordinates
 249     // which represent column and line.
 250     virtual long XYToPosition(long x, long y) const;
 251     DocDeclA(
 252         virtual /*bool*/ void, PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const,
 253         "PositionToXY(long pos) -> (x, y)");
 254
 255     virtual void ShowPosition(long pos);
 256
 257
 258     DocDeclAStr(
 259         virtual wxTextCtrlHitTestResult, HitTest(const wxPoint& pt,
 260                                                  long* OUTPUT, long* OUTPUT) const,
 261         "HitTest(Point pt) -> (result, row, col)",
 262         "Find the character at position given in pixels. NB: pt is in device
 263 coords but is not adjusted for the client area origin nor scrolling", "");
 264
 265
 266     // Clipboard operations
 267     virtual void Copy();
 268     virtual void Cut();
 269     virtual void Paste();
 270
 271     virtual bool CanCopy() const;
 272     virtual bool CanCut() const;
 273     virtual bool CanPaste() const;
 274
 275     // Undo/redo
 276     virtual void Undo();
 277     virtual void Redo();
 278
 279     virtual bool CanUndo() const;
 280     virtual bool CanRedo() const;
 281
 282     // Insertion point
 283     virtual void SetInsertionPoint(long pos);
 284     virtual void SetInsertionPointEnd();
 285     virtual long GetInsertionPoint() const;
 286     virtual long GetLastPosition() const;
 287
 288     virtual void SetSelection(long from, long to);
 289     virtual void SelectAll();
 290     virtual void SetEditable(bool editable);
 291
 292 #ifdef __WXMSW__
 293     // Caret handling (Windows only)
 294     bool ShowNativeCaret(bool show = True);
 295     bool HideNativeCaret();
 296 #endif
 297
 298     %extend {
 299         // TODO: Add more file-like methods
 300         void write(const wxString& text) {
 301             self->AppendText(text);
 302         }
 303     }
 304
 305     // TODO: replace this when the method is really added to wxTextCtrl
 306     %extend {
 307         wxString GetString(long from, long to) {
 308             return self->GetValue().Mid(from, to - from);
 309         }
 310     }
 311
 312     static wxVisualAttributes
 313     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 314 };
 315
 316 //---------------------------------------------------------------------------
 317
 318
 319 %constant wxEventType wxEVT_COMMAND_TEXT_UPDATED;
 320 %constant wxEventType wxEVT_COMMAND_TEXT_ENTER;
 321 %constant wxEventType wxEVT_COMMAND_TEXT_URL;
 322 %constant wxEventType wxEVT_COMMAND_TEXT_MAXLEN;
 323
 324
 325 class wxTextUrlEvent : public wxCommandEvent
 326 {
 327 public:
 328     wxTextUrlEvent(int winid, const wxMouseEvent& evtMouse,
 329                    long start, long end);
 330
 331     // get the mouse event which happend over the URL
 332     const wxMouseEvent& GetMouseEvent();
 333
 334     // get the start of the URL
 335     long GetURLStart() const;
 336
 337     // get the end of the URL
 338     long GetURLEnd() const;
 339 };
 340
 341
 342 %pythoncode {
 343 EVT_TEXT        = wx.PyEventBinder( wxEVT_COMMAND_TEXT_UPDATED, 1)
 344 EVT_TEXT_ENTER  = wx.PyEventBinder( wxEVT_COMMAND_TEXT_ENTER, 1)
 345 EVT_TEXT_URL    = wx.PyEventBinder( wxEVT_COMMAND_TEXT_URL, 1)
 346 EVT_TEXT_MAXLEN = wx.PyEventBinder( wxEVT_COMMAND_TEXT_MAXLEN, 1)
 347 }
 348
 349
 350
 351
 352 //---------------------------------------------------------------------------
 353