added wxTextEntry common base class for both wxTextCtrl and wxComboBox; refactor wxGTK code to put common parts of these classes in the base class; fixed some inconsistencies in the text control behaviour between platforms

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48944 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/textentry.h

@@ -0,0 +1,191 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/textentry.h
+// Purpose:     declares wxTextEntry interface defining a simple text entry
+// Author:      Vadim Zeitlin
+// Created:     2007-09-24
+// RCS-ID:      $Id$
+// Copyright:   (c) 2007 Vadim Zeitlin <vadim@wxwindows.org>
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_TEXTENTRY_H_
+#define _WX_TEXTENTRY_H_
+
+// wxTextPos is the position in the text (currently it's hardly used anywhere
+// and should probably be replaced with int anyhow)
+typedef long wxTextPos;
+
+// ----------------------------------------------------------------------------
+// wxTextEntryBase
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxTextEntryBase
+{
+public:
+    wxTextEntryBase() { m_eventsBlock = 0; }
+    virtual ~wxTextEntryBase() { }
+
+
+    // accessing the value
+    // -------------------
+
+    // 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); }
+
+    // writing text inserts it at the current position replacing any current
+    // selection, appending always inserts it at the end and doesn't remove any
+    // existing text (but it will reset the selection if there is any)
+    virtual void WriteText(const wxString& text) = 0;
+    virtual void AppendText(const wxString& text);
+
+    virtual wxString GetValue() const = 0;
+    virtual wxString GetRange(long from, long to) const;
+    bool IsEmpty() const { return GetValue().empty(); }
+
+
+    // editing operations
+    // ------------------
+
+    virtual void Replace(long from, long to, const wxString& value);
+    virtual void Remove(long from, long to) = 0;
+    virtual void Clear() { SetValue(wxString()); }
+
+
+    // clipboard operations
+    // --------------------
+
+    virtual void Copy() = 0;
+    virtual void Cut() = 0;
+    virtual void Paste() = 0;
+
+    virtual bool CanCopy() const;
+    virtual bool CanCut() const;
+    virtual bool CanPaste() const;
+
+    // undo/redo
+    // ---------
+
+    virtual void Undo() = 0;
+    virtual void Redo() = 0;
+
+    virtual bool CanUndo() const = 0;
+    virtual bool CanRedo() const = 0;
+
+
+    // insertion point
+    // ---------------
+
+    // note that moving insertion point removes any current selection
+    virtual void SetInsertionPoint(long pos) = 0;
+    virtual void SetInsertionPointEnd() { SetInsertionPoint(-1); }
+    virtual long GetInsertionPoint() const = 0;
+    virtual long GetLastPosition() const = 0;
+
+
+    // selection
+    // ---------
+
+    virtual void SetSelection(long from, long to) = 0;
+    virtual void SelectAll() { SetSelection(0, GetLastPosition()); }
+    virtual void GetSelection(long *from, long *to) const = 0;
+    bool HasSelection() const;
+    virtual wxString GetStringSelection() const;
+
+
+    // status
+    // ------
+    virtual bool IsEditable() const = 0;
+    virtual void SetEditable(bool editable) = 0;
+
+
+    // set the max number of characters which may be entered in a single line
+    // text control
+    virtual void SetMaxLength(unsigned long WXUNUSED(len)) { }
+
+
+protected:
+    // flags for DoSetValue(): common part of SetValue() and ChangeValue() and
+    // also used to implement WriteText() in wxMSW
+    enum
+    {
+        SetValue_NoEvent = 0,
+        SetValue_SendEvent = 1,
+        SetValue_SelectionOnly = 2
+    };
+
+    virtual void DoSetValue(const wxString& value, int flags);
+
+    // class which should be used to temporarily disable text change events
+    //
+    // if suppress argument in ctor is false, nothing is done
+    class EventsSuppressor
+    {
+    public:
+        EventsSuppressor(wxTextEntryBase *text, bool suppress = true)
+        {
+            m_suppress = suppress;
+            if ( m_suppress )
+            {
+                m_text = text;
+                m_text->SuppressTextChangedEvents();
+            }
+        }
+
+        ~EventsSuppressor()
+        {
+            if ( m_suppress )
+                m_text->ResumeTextChangedEvents();
+        }
+
+    private:
+        wxTextEntryBase *m_text;
+        bool m_suppress;
+    };
+
+    // return true if the events are currently not suppressed
+    bool EventsAllowed() const { return m_eventsBlock == 0; }
+
+private:
+    // suppress or resume the text changed events generation: don't use these
+    // functions directly, use EventsSuppressor class above instead
+    void SuppressTextChangedEvents()
+    {
+        if ( !m_eventsBlock++ )
+            EnableTextChangedEvents(false);
+    }
+
+    void ResumeTextChangedEvents()
+    {
+        if ( !--m_eventsBlock )
+            EnableTextChangedEvents(true);
+    }
+
+
+    // this must be overridden in the derived classes if our implementation of
+    // SetValue() or Replace() is used to disable (and enable back) generation
+    // of the text changed events
+    //
+    // initially the generation of the events is enabled
+    virtual void EnableTextChangedEvents(bool WXUNUSED(enable)) { }
+
+
+    friend class EventsSuppressor;
+
+    // if this counter is non-null, events are blocked
+    unsigned m_eventsBlock;
+};
+
+#ifdef __WXGTK20__
+    #include "wx/gtk/textentry.h"
+#else
+    // no platform-specific implementation of wxTextEntry yet
+    class WXDLLIMPEXP_CORE wxTextEntry : public wxTextEntryBase
+    {
+    };
+#endif
+
+#endif // _WX_TEXTENTRY_H_
+