embedded sample's README updates

[wxWidgets.git] / wxPython / src / _textctrl.i

diff --git a/wxPython/src/_textctrl.i b/wxPython/src/_textctrl.i
index 493598f3608c84e59bef3a91b4a96c8b56408d3a..01cad4d056e129ccf5effce8b89e0ece9035d992 100644 (file)
--- a/wxPython/src/_textctrl.i
+++ b/wxPython/src/_textctrl.i
@@ -15,9 +15,7 @@
 
 //---------------------------------------------------------------------------
 
-%{
-    DECLARE_DEF_STRING(TextCtrlNameStr);
-%}
+MAKE_CONST_WXSTRING(TextCtrlNameStr);
 
 //---------------------------------------------------------------------------
 %newgroup
@@ -92,6 +90,15 @@ enum {
     wxTEXT_ATTR_TABS
 };
 
+enum wxTextCtrlHitTestResult
+{
+    wxTE_HT_UNKNOWN = -2,   // this means HitTest() is simply not implemented
+    wxTE_HT_BEFORE,         // either to the left or upper
+    wxTE_HT_ON_TEXT,        // directly on
+    wxTE_HT_BELOW,          // below [the last line]
+    wxTE_HT_BEYOND          // after [the end of line]
+};
+
 //---------------------------------------------------------------------------
 
 // wxTextAttr: a structure containing the visual attributes of a text
@@ -104,7 +111,8 @@ public:
                const wxColour& colBack = wxNullColour,
                const wxFont& font = wxNullFont,
                wxTextAttrAlignment alignment = wxTEXT_ALIGNMENT_DEFAULT);
-
+    ~wxTextAttr();
+    
     // operations
     void Init();
 
@@ -137,7 +145,7 @@ public:
     long GetRightIndent() const;
     long GetFlags() const;
 
-    // returns false if we have any attributes set, true otherwise
+    // returns False if we have any attributes set, True otherwise
     bool IsDefault() const;
 
     // return the attribute having the valid font and colours: it uses the
@@ -155,8 +163,8 @@ public:
 class wxTextCtrl : public wxControl
 {
 public:
-    %addtofunc wxTextCtrl         "self._setOORInfo(self)"
-    %addtofunc wxTextCtrl()       ""
+    %pythonAppend wxTextCtrl         "self._setOORInfo(self)"
+    %pythonAppend wxTextCtrl()       ""
 
     wxTextCtrl(wxWindow* parent, wxWindowID id,
                const wxString& value = wxPyEmptyString,
@@ -192,8 +200,11 @@ public:
     bool IsSingleLine() const;
     bool IsMultiLine() const;
 
-    // If the return values from and to are the same, there is no selection.
-    virtual void GetSelection(long* OUTPUT, long* OUTPUT) const;
+
+    DocDeclAStr(
+        virtual void, GetSelection(long* OUTPUT, long* OUTPUT) const,
+        "GetSelection() -> (from, to)",
+        "If the return values from and to are the same, there is no selection.");
 
     virtual wxString GetStringSelection() const;
 
@@ -221,7 +232,7 @@ public:
     virtual void AppendText(const wxString& text);
 
     // insert the character which would have resulted from this key event,
-    // return TRUE if anything has been inserted
+    // return True if anything has been inserted
     virtual bool EmulateKeyPress(const wxKeyEvent& event);
 
     // text control under some platforms supports the text styles: these
@@ -236,10 +247,22 @@ public:
     // considering all its contents as a single strings) and (x, y) coordinates
     // which represent column and line.
     virtual long XYToPosition(long x, long y) const;
-    virtual /*bool*/ void PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const;
+    DocDeclA(
+        virtual /*bool*/ void, PositionToXY(long pos, long *OUTPUT, long *OUTPUT) const,
+        "PositionToXY(long pos) -> (x, y)");
 
     virtual void ShowPosition(long pos);
 
+
+    DocDeclAStr(
+        virtual wxTextCtrlHitTestResult, HitTest(const wxPoint& pt,
+                                                 long* OUTPUT, long* OUTPUT) const,
+        "HitTest(Point pt) -> (result, row, col)",
+        "Find the character at position given in pixels.\n"
+        "NB: pt is in device coords (not adjusted for the client area\n"
+        "origin nor scrolling)");
+
+
     // Clipboard operations
     virtual void Copy();
     virtual void Cut();
@@ -268,7 +291,7 @@ public:
 
 #ifdef __WXMSW__
     // Caret handling (Windows only)
-    bool ShowNativeCaret(bool show = true);
+    bool ShowNativeCaret(bool show = True);
     bool HideNativeCaret();
 #endif