fix some typos/imprecisions

[wxWidgets.git] / include / wx / gtk / textctrl.h

diff --git a/include/wx/gtk/textctrl.h b/include/wx/gtk/textctrl.h
index 10b4dcce0e90a89fbcfbb6b0c4e2628644579340..28554b1f9661ddafd79754108ad3aec337471b26 100644 (file)
--- a/include/wx/gtk/textctrl.h
+++ b/include/wx/gtk/textctrl.h
@@ -1,31 +1,23 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        textctrl.h
+// Name:        wx/gtk/textctrl.h

 // Purpose:
 // Author:      Robert Roebling
 // Created:     01/02/97
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Created:     01/02/97
 // Id:          $Id$

-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
+// Copyright:   (c) 1998 Robert Roebling

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKTEXTCTRLH__
-#define __GTKTEXTCTRLH__
+#ifndef _WX_GTK_TEXTCTRL_H_
+#define _WX_GTK_TEXTCTRL_H_

 
 

-#ifdef __GNUG__
-    #pragma interface "textctrl.h"
-#endif
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxTextCtrl;
+typedef struct _GtkTextMark GtkTextMark;

 
 //-----------------------------------------------------------------------------
 // wxTextCtrl
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxTextCtrl
 //-----------------------------------------------------------------------------
 

-class wxTextCtrl: public wxTextCtrlBase
+class WXDLLIMPEXP_CORE wxTextCtrl: public wxTextCtrlBase

 {
 public:
     wxTextCtrl() { Init(); }
 {
 public:
     wxTextCtrl() { Init(); }


@@ -38,6 +30,8 @@ public:
                const wxValidator& validator = wxDefaultValidator,
                const wxString &name = wxTextCtrlNameStr);
 
                const wxValidator& validator = wxDefaultValidator,
                const wxString &name = wxTextCtrlNameStr);
 

+    virtual ~wxTextCtrl();
+

     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxString &value = wxEmptyString,
     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxString &value = wxEmptyString,


@@ -50,8 +44,9 @@ public:
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------
 

+    virtual void WriteText(const wxString& text);

     virtual wxString GetValue() const;
     virtual wxString GetValue() const;

-    virtual void SetValue(const wxString& value);
+    virtual bool IsEmpty() const;

 
     virtual int GetLineLength(long lineNo) const;
     virtual wxString GetLineText(long lineNo) const;
 
     virtual int GetLineLength(long lineNo) const;
     virtual wxString GetLineText(long lineNo) const;


@@ -60,27 +55,13 @@ public:
     virtual bool IsModified() const;
     virtual bool IsEditable() const;
 
     virtual bool IsModified() const;
     virtual bool IsEditable() const;
 

-    // If the return values from and to are the same, there is no selection.

     virtual void GetSelection(long* from, long* to) const;
 
     virtual void GetSelection(long* from, long* to) const;
 

-    // operations
-    // ----------
-
-    // editing
-    virtual void Clear();
-    virtual void Replace(long from, long to, const wxString& value);

     virtual void Remove(long from, long to);
 
     virtual void Remove(long from, long to);
 

-    // clears the dirty flag
+    virtual void MarkDirty();

     virtual void DiscardEdits();
 
     virtual void DiscardEdits();
 

-    // writing text inserts it at the current position, appending always
-    // inserts it at the end
-    virtual void WriteText(const wxString& text);
-    virtual void AppendText(const wxString& text);
-
-    // apply text attribute to the range of text (only works with richedit
-    // controls)

     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 
     // translate between the position (which is just an index in the text ctrl
     virtual bool SetStyle(long start, long end, const wxTextAttr& style);
 
     // translate between the position (which is just an index in the text ctrl


@@ -91,28 +72,30 @@ public:
 
     virtual void ShowPosition(long pos);
 
 
     virtual void ShowPosition(long pos);
 

+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt, long *pos) const;
+    virtual wxTextCtrlHitTestResult HitTest(const wxPoint& pt,
+                                            wxTextCoord *col,
+                                            wxTextCoord *row) const
+    {
+        return wxTextCtrlBase::HitTest(pt, col, row);
+    }
+

     // Clipboard operations
     virtual void Copy();
     virtual void Cut();
     virtual void Paste();
 
     // Clipboard operations
     virtual void Copy();
     virtual void Cut();
     virtual void Paste();
 

-    // Undo/redo
-    virtual void Undo();
-    virtual void Redo();
-
-    virtual bool CanUndo() const;
-    virtual bool CanRedo() const;
-

     // Insertion point
     virtual void SetInsertionPoint(long pos);
     // Insertion point
     virtual void SetInsertionPoint(long pos);

-    virtual void SetInsertionPointEnd();

     virtual long GetInsertionPoint() const;
     virtual long GetInsertionPoint() const;

-    virtual long GetLastPosition() const;
+    virtual wxTextPos GetLastPosition() const;

 
     virtual void SetSelection(long from, long to);
     virtual void SetEditable(bool editable);
 
 
     virtual void SetSelection(long from, long to);
     virtual void SetEditable(bool editable);
 

-    virtual bool Enable( bool enable );
+    // Overridden wxWindow methods
+    virtual void SetWindowStyleFlag( long style );
+    virtual bool Enable( bool enable = true );

 
     // Implementation from now on
     void OnDropFiles( wxDropFilesEvent &event );
 
     // Implementation from now on
     void OnDropFiles( wxDropFilesEvent &event );


@@ -135,38 +118,116 @@ public:
     bool SetBackgroundColour(const wxColour& colour);
 
     GtkWidget* GetConnectWidget();
     bool SetBackgroundColour(const wxColour& colour);
 
     GtkWidget* GetConnectWidget();

-    bool IsOwnGtkWindow( GdkWindow *window );
-    void ApplyWidgetStyle();
-    void CalculateScrollbar();
-    void OnInternalIdle();
-    void UpdateFontIfNeeded();

 
 

-    void SetModified() { m_modified = TRUE; }
+    void SetUpdateFont(bool WXUNUSED(update)) { }
+
+    // GTK+ textctrl is so dumb that you need to freeze/thaw it manually to
+    // avoid horrible flicker/scrolling back and forth
+    virtual void Freeze();
+    virtual void Thaw();
+
+    // implementation only from now on
+
+    // tell the control to ignore next text changed signal
+    void IgnoreNextTextUpdate(int n = 1) { m_countUpdatesToIgnore = n; }
+
+    // should we ignore the changed signal? always resets the flag
+    bool IgnoreTextUpdate();
+
+    // call this to indicate that the control is about to be changed
+    // programmatically and so m_modified flag shouldn't be set
+    void DontMarkDirtyOnNextChange() { m_dontMarkDirty = true; }
+
+    // should we mark the control as dirty? always resets the flag
+    bool MarkDirtyOnChange();
+
+    // always let GTK have mouse release events for multiline controls
+    virtual bool GTKProcessEvent(wxEvent& event) const;

 
 

+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+    // has the control been frozen by Freeze()?
+    bool IsFrozen() const { return m_freezeCount > 0; }
+
+protected:

     // wxGTK-specific: called recursively by Enable,
     // to give widgets an oppprtunity to correct their colours after they
     // have been changed by Enable
     // wxGTK-specific: called recursively by Enable,
     // to give widgets an oppprtunity to correct their colours after they
     // have been changed by Enable

-    virtual void OnParentEnable( bool enable ) ;
+    virtual void OnEnabled(bool enable);

 
 

-protected:
+    // overridden wxWindow virtual methods

     virtual wxSize DoGetBestSize() const;
     virtual wxSize DoGetBestSize() const;

+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;

 
     // common part of all ctors
     void Init();
 
 
     // common part of all ctors
     void Init();
 

+    // Widgets that use the style->base colour for the BG colour should
+    // override this and return true.
+    virtual bool UseGTKStyleBase() const { return true; }
+
+    virtual void DoSetValue(const wxString &value, int flags = 0);
+
+    // wrappers hiding the differences between functions doing the same thing
+    // for GtkTextView and GtkEntry (all of them use current window style to
+    // set the given characteristic)
+    void GTKSetEditable();
+    void GTKSetVisibility();
+    void GTKSetActivatesDefault();
+    void GTKSetWrapMode();
+    void GTKSetJustification();
+

 private:
 private:

+    // overridden wxTextEntry virtual methods
+    virtual const wxWindow *GetEditableWindow() const { return this; }
+    virtual GtkEditable *GetEditable() const;
+    virtual void EnableTextChangedEvents(bool enable);
+

     // change the font for everything in this control
     void ChangeFontGlobally();
 
     // change the font for everything in this control
     void ChangeFontGlobally();
 

-    bool        m_modified;
+    // get the encoding which is used in this control: this looks at our font
+    // and default style but not the current style (i.e. the style for the
+    // current position); returns wxFONTENCODING_SYSTEM if we have no specific
+    // encoding
+    wxFontEncoding GetTextEncoding() const;
+
+    // returns either m_text or m_buffer depending on whether the control is
+    // single- or multi-line; convenient for the GTK+ functions which work with
+    // both
+    void *GetTextObject() const
+    {
+        return IsMultiLine() ? wx_static_cast(void *, m_buffer)
+                             : wx_static_cast(void *, m_text);
+    }
+
+
+    // the widget used for single line controls

     GtkWidget  *m_text;
     GtkWidget  *m_text;

-    GtkWidget  *m_vScrollbar;
-    bool        m_vScrollbarVisible;
-    bool        m_updateFont;
+
+    bool        m_modified:1;
+    bool        m_dontMarkDirty:1;
+
+    int         m_countUpdatesToIgnore;
+
+    // Our text buffer. Convenient, and holds the buffer while using
+    // a dummy one when frozen
+    GtkTextBuffer *m_buffer;
+
+    // number of calls to Freeze() minus number of calls to Thaw()
+    unsigned m_freezeCount;
+    GtkTextMark* m_showPositionOnThaw;
+
+    // For wxTE_AUTO_URL
+    void OnUrlMouseEvent(wxMouseEvent&);
+    GdkCursor *m_gdkHandCursor;
+    GdkCursor *m_gdkXTermCursor;

 
     DECLARE_EVENT_TABLE()
 
     DECLARE_EVENT_TABLE()

-    DECLARE_DYNAMIC_CLASS(wxTextCtrl);
+    DECLARE_DYNAMIC_CLASS(wxTextCtrl)

 };
 
 };
 

-#endif // __GTKTEXTCTRLH__
-
+#endif // _WX_GTK_TEXTCTRL_H_