synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/gtk1/textctrl.h b/include/wx/gtk1/textctrl.h
index 5faee033c610e92b27f6d3e9522cc65e5096bc27..c594bc46b2fda31d8c84dd9bb3c426a33f7407bf 100644 (file)
--- a/include/wx/gtk1/textctrl.h
+++ b/include/wx/gtk1/textctrl.h
@@ -1,34 +1,24 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        textctrl.h
+// Name:        wx/gtk1/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__
-    #pragma interface "textctrl.h"
-#endif
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxTextCtrl;
-

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

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

 {
 public:
 {
 public:

-    wxTextCtrl();
+    wxTextCtrl() { Init(); }

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


@@ -38,6 +28,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,9 +42,6 @@ public:
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------
 

-    virtual wxString GetValue() const;
-    virtual void SetValue(const wxString& value);
-

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


@@ -71,14 +60,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.


@@ -92,10 +88,6 @@ public:
     virtual void Cut();
     virtual void Paste();
 
     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();


@@ -107,12 +99,12 @@ 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 );
+    virtual void DoEnable( bool enable );

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


@@ -130,29 +122,79 @@ 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; }
+    void SetUpdateFont(bool update) { m_updateFont = update; }
+    void UpdateFontIfNeeded();
+
+    void SetModified() { m_modified = true; }
+
+    // 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 OnEnabled( bool enabled ) ;
+
+    // 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();
+
+    // overridden wxWindow methods
+    virtual void DoFreeze();
+    virtual void DoThaw();
+
+    // 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; }
+
+    virtual void DoSetValue(const wxString &value, int flags = 0);
+    virtual wxString DoGetValue() const;
+

 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;
+    bool        m_updateFont:1;
+    bool        m_ignoreNextUpdate:1;

 
     DECLARE_EVENT_TABLE()
 
     DECLARE_EVENT_TABLE()

-    DECLARE_DYNAMIC_CLASS(wxTextCtrl);
+    DECLARE_DYNAMIC_CLASS(wxTextCtrl)

 };
 
 #endif // __GTKTEXTCTRLH__
 };
 
 #endif // __GTKTEXTCTRLH__