Make list consistent with tree in terms of Vetoed changes closing the inline edit...

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

diff --git a/include/wx/gtk/textctrl.h b/include/wx/gtk/textctrl.h
index 7c18d927dc6d615a7a4dd8f605657ce88a80657c..a13d3270c37df0105d2058e15ce92cd762db464a 100644 (file)
--- a/include/wx/gtk/textctrl.h
+++ b/include/wx/gtk/textctrl.h
@@ -1,26 +1,20 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKTEXTCTRLH__
 #define __GTKTEXTCTRLH__
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKTEXTCTRLH__
 #define __GTKTEXTCTRLH__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "textctrl.h"
 #endif
 
     #pragma interface "textctrl.h"
 #endif
 

-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxTextCtrl;
-

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


@@ -28,15 +22,24 @@ class wxTextCtrl;
 class wxTextCtrl: public wxTextCtrlBase
 {
 public:
 class wxTextCtrl: public wxTextCtrlBase
 {
 public:

-    wxTextCtrl();
-    wxTextCtrl( wxWindow *parent, wxWindowID id, const wxString &value = "",
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      int style = 0, const wxValidator& validator = wxDefaultValidator,
-      const wxString &name = wxTextCtrlNameStr );
-    bool Create( wxWindow *parent, wxWindowID id, const wxString &value = "",
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      int style = 0, const wxValidator& validator = wxDefaultValidator,
-      const wxString &name = wxTextCtrlNameStr );
+    wxTextCtrl() { Init(); }
+    wxTextCtrl(wxWindow *parent,
+               wxWindowID id,
+               const wxString &value = wxEmptyString,
+               const wxPoint &pos = wxDefaultPosition,
+               const wxSize &size = wxDefaultSize,
+               long style = 0,
+               const wxValidator& validator = wxDefaultValidator,
+               const wxString &name = wxTextCtrlNameStr);
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString &value = wxEmptyString,
+                const wxPoint &pos = wxDefaultPosition,
+                const wxSize &size = wxDefaultSize,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString &name = wxTextCtrlNameStr);

 
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------


@@ -62,14 +65,21 @@ public:
     virtual void Replace(long from, long to, const wxString& value);
     virtual void Remove(long from, long to);
 
     virtual void Replace(long from, long to, const wxString& value);
     virtual void Remove(long from, long to);
 

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

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

+    virtual void SetMaxLength(unsigned long len);
+

     // 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);
 
     // 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
     // considering all its contents as a single strings) and (x, y) coordinates
     // which represent column and line.
     // translate between the position (which is just an index in the text ctrl
     // considering all its contents as a single strings) and (x, y) coordinates
     // which represent column and line.


@@ -78,15 +88,21 @@ public:
 
     virtual void ShowPosition(long pos);
 
 
     virtual void ShowPosition(long pos);
 

+#ifdef __WXGTK20__
+    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);
+    }
+#endif // __WXGTK20__
+

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

-    virtual bool CanCopy() const;
-    virtual bool CanCut() const;
-    virtual bool CanPaste() const;
-

     // Undo/redo
     virtual void Undo();
     virtual void Redo();
     // Undo/redo
     virtual void Undo();
     virtual void Redo();


@@ -98,11 +114,13 @@ public:
     virtual void SetInsertionPoint(long pos);
     virtual void SetInsertionPointEnd();
     virtual long GetInsertionPoint() const;
     virtual void SetInsertionPoint(long pos);
     virtual void SetInsertionPointEnd();
     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 = true );
+

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


@@ -119,26 +137,94 @@ public:
     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 

-    bool SetFont( const wxFont &font );
-    bool SetForegroundColour(const wxColour &colour);
-    bool SetBackgroundColour(const wxColour &colour);
+    bool SetFont(const wxFont& font);
+    bool SetForegroundColour(const wxColour& colour);
+    bool SetBackgroundColour(const wxColour& colour);

 
     GtkWidget* GetConnectWidget();
     bool IsOwnGtkWindow( GdkWindow *window );
 
     GtkWidget* GetConnectWidget();
     bool IsOwnGtkWindow( GdkWindow *window );

-    void ApplyWidgetStyle();
+    void DoApplyWidgetStyle(GtkRcStyle *style);

     void CalculateScrollbar();
     void OnInternalIdle();
 
     void CalculateScrollbar();
     void OnInternalIdle();
 

-    void SetModified() { m_modified = TRUE; }
+#ifdef __WXGTK20__
+    void SetUpdateFont(bool WXUNUSED(update)) { }
+#else // !__WXGTK20__
+    void SetUpdateFont(bool update) { m_updateFont = update; }
+    void UpdateFontIfNeeded();
+#endif // __WXGTK20__/!__WXGTK20__
+
+    void SetModified() { m_modified = true; }
+
+    // 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();
+
+    // textctrl specific scrolling
+    virtual bool ScrollLines(int lines);
+    virtual bool ScrollPages(int pages);
+
+    // implementation only from now on
+
+    // 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 ) ;
+
+    // tell the control to ignore next text changed signal
+    void IgnoreNextTextUpdate();
+
+    // should we ignore the changed signal? always resets the flag
+    bool IgnoreTextUpdate();
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

 
 protected:
     virtual wxSize DoGetBestSize() const;
 
 
 protected:
     virtual wxSize DoGetBestSize() const;
 

+    // common part of all ctors
+    void Init();
+
+    // get the vertical adjustment, if any, NULL otherwise
+    GtkAdjustment *GetVAdj() const;
+
+    // scroll the control by the given number of pixels, return true if the
+    // scroll position changed
+    bool DoScroll(GtkAdjustment *adj, int diff);
+
+    // Widgets that use the style->base colour for the BG colour should
+    // override this and return true.
+    virtual bool UseGTKStyleBase() const { return true; }
+
+#ifdef __WXGTK20__
+    // has the control been frozen by Freeze()?
+    bool IsFrozen() const { return m_frozenness > 0; }
+#endif
+

 private:
 private:

-    bool        m_modified;
+    // change the font for everything in this control
+    void ChangeFontGlobally();
+

     GtkWidget  *m_text;
     GtkWidget  *m_vScrollbar;
     GtkWidget  *m_text;
     GtkWidget  *m_vScrollbar;

-    bool        m_vScrollbarVisible;
+
+    bool        m_modified:1;
+    bool        m_vScrollbarVisible:1;
+#ifndef __WXGTK20__
+    bool        m_updateFont:1;
+#endif // !__WXGTK20__
+    bool        m_ignoreNextUpdate:1;
+
+#ifdef __WXGTK20__
+    // Our text buffer. Convenient, and holds the buffer while using
+    // a dummy one when m_frozenness > 0
+    GtkTextBuffer *m_buffer;
+
+    // number of calls to Freeze() minus number of calls to Thaw()
+    unsigned int m_frozenness;
+#endif

 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxTextCtrl);
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxTextCtrl);