Extend history api using the ie backend to include loading history items, and getting...

[wxWidgets.git] / include / wx / textentry.h

diff --git a/include/wx/textentry.h b/include/wx/textentry.h
index 701893bc8f2c5671c4ca78b05e8e32130cdf00b3..7601444ca84d89360c0b2cbfcd2af2850ab5e52d 100644 (file)
--- a/include/wx/textentry.h
+++ b/include/wx/textentry.h
@@ -16,6 +16,7 @@
 typedef long wxTextPos;
 
 class WXDLLIMPEXP_FWD_BASE wxArrayString;
 typedef long wxTextPos;
 
 class WXDLLIMPEXP_FWD_BASE wxArrayString;

+class WXDLLIMPEXP_FWD_CORE wxTextCompleter;

 class WXDLLIMPEXP_FWD_CORE wxTextEntryHintData;
 class WXDLLIMPEXP_FWD_CORE wxWindow;
 
 class WXDLLIMPEXP_FWD_CORE wxTextEntryHintData;
 class WXDLLIMPEXP_FWD_CORE wxWindow;
 


@@ -38,8 +39,7 @@ public:
     // SetValue() generates a text change event, ChangeValue() doesn't
     virtual void SetValue(const wxString& value)
         { DoSetValue(value, SetValue_SendEvent); }
     // SetValue() generates a text change event, ChangeValue() doesn't
     virtual void SetValue(const wxString& value)
         { DoSetValue(value, SetValue_SendEvent); }

-    virtual void ChangeValue(const wxString& value)
-        { DoSetValue(value, SetValue_NoEvent); }
+    virtual void ChangeValue(const wxString& value);

 
     // writing text inserts it at the current position replacing any current
     // selection, appending always inserts it at the end and doesn't remove any
 
     // writing text inserts it at the current position replacing any current
     // selection, appending always inserts it at the end and doesn't remove any


@@ -107,18 +107,23 @@ public:
 
     // these functions allow to auto-complete the text already entered into the
     // control using either the given fixed list of strings, the paths from the
 
     // these functions allow to auto-complete the text already entered into the
     // control using either the given fixed list of strings, the paths from the

-    // file system or, in the future, an arbitrary user-defined completer
+    // file system or an arbitrary user-defined completer

     //
     // they all return true if completion was enabled or false on error (most
     // commonly meaning that this functionality is not available under the
     // current platform)
 
     //
     // they all return true if completion was enabled or false on error (most
     // commonly meaning that this functionality is not available under the
     // current platform)
 

-    virtual bool AutoComplete(const wxArrayString& WXUNUSED(choices))
-    {
-        return false;
-    }
+    bool AutoComplete(const wxArrayString& choices)
+        { return DoAutoCompleteStrings(choices); }

 
 

-    virtual bool AutoCompleteFileNames() { return false; }
+    bool AutoCompleteFileNames()
+        { return DoAutoCompleteFileNames(); }
+
+    // notice that we take ownership of the pointer and will delete it
+    //
+    // if the pointer is NULL auto-completion is disabled
+    bool AutoComplete(wxTextCompleter *completer)
+        { return DoAutoCompleteCustom(completer); }

 
 
     // status
 
 
     // status


@@ -159,8 +164,8 @@ public:
         { return DoGetMargins(); }
 
 
         { return DoGetMargins(); }
 
 

-    // events
-    // ------
+    // implementation only
+    // -------------------

 
     // generate the wxEVT_COMMAND_TEXT_UPDATED event for GetEditableWindow(),
     // like SetValue() does and return true if the event was processed
 
     // generate the wxEVT_COMMAND_TEXT_UPDATED event for GetEditableWindow(),
     // like SetValue() does and return true if the event was processed


@@ -168,6 +173,36 @@ public:
     // NB: this is public for wxRichTextCtrl use only right now, do not call it
     static bool SendTextUpdatedEvent(wxWindow *win);
 
     // NB: this is public for wxRichTextCtrl use only right now, do not call it
     static bool SendTextUpdatedEvent(wxWindow *win);
 

+    // generate the wxEVT_COMMAND_TEXT_UPDATED event for this window
+    bool SendTextUpdatedEvent()
+    {
+        return SendTextUpdatedEvent(GetEditableWindow());
+    }
+
+
+    // generate the wxEVT_COMMAND_TEXT_UPDATED event for this window if the
+    // events are not currently disabled
+    void SendTextUpdatedEventIfAllowed()
+    {
+        if ( EventsAllowed() )
+            SendTextUpdatedEvent();
+    }
+
+    // this function is provided solely for the purpose of forwarding text
+    // change notifications state from one control to another, e.g. it can be
+    // used by a wxComboBox which derives from wxTextEntry if it delegates all
+    // of its methods to another wxTextCtrl
+    void ForwardEnableTextChangedEvents(bool enable)
+    {
+        // it's important to call the functions which update m_eventsBlock here
+        // and not just our own EnableTextChangedEvents() because our state
+        // (i.e. the result of EventsAllowed()) must change as well
+        if ( enable )
+            ResumeTextChangedEvents();
+        else
+            SuppressTextChangedEvents();
+    }
+

 protected:
     // flags for DoSetValue(): common part of SetValue() and ChangeValue() and
     // also used to implement WriteText() in wxMSW
 protected:
     // flags for DoSetValue(): common part of SetValue() and ChangeValue() and
     // also used to implement WriteText() in wxMSW


@@ -189,6 +224,15 @@ protected:
     virtual bool DoSetMargins(const wxPoint& pt);
     virtual wxPoint DoGetMargins() const;
 
     virtual bool DoSetMargins(const wxPoint& pt);
     virtual wxPoint DoGetMargins() const;
 

+    // the derived classes should override these virtual methods to implement
+    // auto-completion, they do the same thing as their public counterparts but
+    // have different names to allow overriding just one of them without hiding
+    // the other one(s)
+    virtual bool DoAutoCompleteStrings(const wxArrayString& WXUNUSED(choices))
+        { return false; }
+    virtual bool DoAutoCompleteFileNames() { return false; }
+    virtual bool DoAutoCompleteCustom(wxTextCompleter *completer);
+

 
     // class which should be used to temporarily disable text change events
     //
 
     // class which should be used to temporarily disable text change events
     //


@@ -217,20 +261,6 @@ protected:
 
     friend class EventsSuppressor;
 
 
     friend class EventsSuppressor;
 

-    // generate the wxEVT_COMMAND_TEXT_UPDATED event for this window
-    bool SendTextUpdatedEvent()
-    {
-        return SendTextUpdatedEvent(GetEditableWindow());
-    }
-
-    // generate the wxEVT_COMMAND_TEXT_UPDATED event for this window if the
-    // events are not currently disabled
-    void SendTextUpdatedEventIfAllowed()
-    {
-        if ( EventsAllowed() )
-            SendTextUpdatedEvent();
-    }
-

 private:
     // suppress or resume the text changed events generation: don't use these
     // functions directly, use EventsSuppressor class above instead
 private:
     // suppress or resume the text changed events generation: don't use these
     // functions directly, use EventsSuppressor class above instead


@@ -263,6 +293,10 @@ private:
 
     // hint-related stuff, only allocated if/when SetHint() is used
     wxTextEntryHintData *m_hintData;
 
     // hint-related stuff, only allocated if/when SetHint() is used
     wxTextEntryHintData *m_hintData;

+
+    // It needs to call our Do{Get,Set}Value() to work with the real control
+    // contents.
+    friend class wxTextEntryHintData;

 };
 
 #ifdef __WXUNIVERSAL__
 };
 
 #ifdef __WXUNIVERSAL__