]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/textctrl.h
Clean up wxMSW wxTreeCtrl code by removing obsolete workarounds.
[wxWidgets.git] / interface / wx / textctrl.h
index c4a470e1d80e4c67e1ad9b8385cf1da107940ca1..35b1e044560797377829f3192aa39b2e65b1457b 100644 (file)
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxTextAttr
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -854,16 +854,18 @@ public:
 
     @beginStyleTable
     @style{wxTE_PROCESS_ENTER}
-           The control will generate the event wxEVT_COMMAND_TEXT_ENTER
+           The control will generate the event @c wxEVT_COMMAND_TEXT_ENTER
            (otherwise pressing Enter key is either processed internally by the
            control or used for navigation between dialog controls).
     @style{wxTE_PROCESS_TAB}
-           The control will receive wxEVT_CHAR events for TAB pressed -
+           The control will receive @c wxEVT_CHAR events for TAB pressed -
            normally, TAB is used for passing to the next control in a dialog
            instead. For the control created with this style, you can still use
            Ctrl-Enter to pass to the next control from the keyboard.
     @style{wxTE_MULTILINE}
-           The text control allows multiple lines.
+           The text control allows multiple lines. If this style is not
+           specified, line break characters should not be used in the controls
+           value.
     @style{wxTE_PASSWORD}
            The text will be echoed as asterisks.
     @style{wxTE_READONLY}
@@ -1047,14 +1049,14 @@ public:
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TEXT(id, func)}
-        Respond to a wxEVT_COMMAND_TEXT_UPDATED event, generated when the text
+        Respond to a @c wxEVT_COMMAND_TEXT_UPDATED event, generated when the text
         changes. Notice that this event will be sent when the text controls
         contents changes -- whether this is due to user input or comes from the
         program itself (for example, if wxTextCtrl::SetValue() is called); see
         wxTextCtrl::ChangeValue() for a function which does not send this event.
         This event is however not sent during the control creation.
     @event{EVT_TEXT_ENTER(id, func)}
-        Respond to a wxEVT_COMMAND_TEXT_ENTER event, generated when enter is
+        Respond to a @c wxEVT_COMMAND_TEXT_ENTER event, generated when enter is
         pressed in a text control which must have wxTE_PROCESS_ENTER style for
         this event to be generated.
     @event{EVT_TEXT_URL(id, func)}
@@ -1234,6 +1236,11 @@ public:
         Please note that this function is currently only implemented in wxUniv, wxMSW
         and wxGTK2 ports.
 
+        @beginWxPerlOnly
+        In wxPerl this function takes only the @a pt argument and
+        returns a 3-element list (result, col, row).
+        @endWxPerlOnly
+
         @see PositionToXY(), XYToPosition()
     */
     wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
@@ -1311,6 +1318,11 @@ public:
             @true on success, @false on failure (most likely due to a too large
             position parameter).
 
+        @beginWxPerlOnly
+        In wxPerl this function takes only the @a pos argument and
+        returns a 2-element list (x, y).
+        @endWxPerlOnly
+
         @see XYToPosition()
     */
     virtual bool PositionToXY(long pos, long* x, long* y) const;