Regenerated FL docs; applied patch [ #511363 ] Dialogs no longer need wx.rc

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

diff --git a/include/wx/gtk/textctrl.h b/include/wx/gtk/textctrl.h
index 2c8d9febeba61126f4838ef068585f49c052a3eb..34df4e683955ed14a4513af698039131327aa4d3 100644 (file)
--- a/include/wx/gtk/textctrl.h
+++ b/include/wx/gtk/textctrl.h
@@ -8,23 +8,11 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-

 #ifndef __GTKTEXTCTRLH__
 #define __GTKTEXTCTRLH__
 
 #ifdef __GNUG__
 #ifndef __GTKTEXTCTRLH__
 #define __GTKTEXTCTRLH__
 
 #ifdef __GNUG__

-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/control.h"
-
-#if USE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
+    #pragma interface "textctrl.h"

 #endif
 
 //-----------------------------------------------------------------------------
 #endif
 
 //-----------------------------------------------------------------------------


@@ -34,79 +22,179 @@
 class wxTextCtrl;
 
 //-----------------------------------------------------------------------------
 class wxTextCtrl;
 
 //-----------------------------------------------------------------------------

-// global data
-//-----------------------------------------------------------------------------
-
-extern const char *wxTextCtrlNameStr;
-
-//-----------------------------------------------------------------------------
-//  wxTextCtrl
+// wxTextCtrl

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxTextCtrl: public wxControl, public streambuf
+class wxTextCtrl: public wxTextCtrlBase

 {
 {

-  DECLARE_EVENT_TABLE()
-  DECLARE_DYNAMIC_CLASS(wxTextCtrl);
-

 public:
 public:

-    wxTextCtrl();
-    wxTextCtrl( wxWindow *parent, wxWindowID id, const wxString &value = "",
-      const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize,
-      int style = 0, 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 wxString &name = wxTextCtrlNameStr );
-    wxString GetValue() const;
-    void SetValue( const wxString &value );
-    void WriteText( const wxString &text );
-
-    bool LoadFile( const wxString &file );
-    bool SaveFile( const wxString &file );
-    bool IsModified() const { return m_modified; }
-    void SetModified() { m_modified = TRUE; }
-    void DiscardEdits() { m_modified = FALSE; }
-/*
-    wxString GetLineText( long lineNo ) const;
-    void OnDropFiles( wxDropFilesEvent &event );
-    long PositionToXY( long pos, long *x, long *y ) const;
-    long XYToPosition( long x, long y );
-    int GetNumberOfLines();
-*/
-    virtual void SetInsertionPoint( long pos );
+    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
+    // ----------------------------------
+
+    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 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;
+
+    // operations
+    // ----------
+
+    // editing
+    virtual void Clear();
+    virtual void Replace(long from, long to, const wxString& value);
+    virtual void Remove(long from, long to);
+
+    // clears the dirty flag
+    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);
+
+    // 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.
+    virtual long XYToPosition(long x, long y) const;
+    virtual bool PositionToXY(long pos, long *x, long *y) const;
+
+    virtual void ShowPosition(long pos);
+
+    // 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);

     virtual void SetInsertionPointEnd();
     virtual void SetInsertionPointEnd();

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

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

-    virtual void Remove( long from, long to );
-    virtual void Replace( long from, long to, const wxString &value );
-    void Cut();
-    void Copy();
-    void Paste();
-    void Delete();

 
 

+    virtual void SetSelection(long from, long to);
+    virtual void SetEditable(bool editable);
+
+    virtual bool Enable( bool enable );
+
+    // Implementation from now on
+    void OnDropFiles( wxDropFilesEvent &event );

     void OnChar( wxKeyEvent &event );
 
     void OnChar( wxKeyEvent &event );
 

-    int overflow(int i);
-    int sync();
-    int underflow();
+    void OnCut(wxCommandEvent& event);
+    void OnCopy(wxCommandEvent& event);
+    void OnPaste(wxCommandEvent& event);
+    void OnUndo(wxCommandEvent& event);
+    void OnRedo(wxCommandEvent& event);
+
+    void OnUpdateCut(wxUpdateUIEvent& event);
+    void OnUpdateCopy(wxUpdateUIEvent& event);
+    void OnUpdatePaste(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);
+
+    GtkWidget* GetConnectWidget();
+    bool IsOwnGtkWindow( GdkWindow *window );
+    void ApplyWidgetStyle();
+    void CalculateScrollbar();
+    void OnInternalIdle();
+    void UpdateFontIfNeeded();

 
 

-    wxTextCtrl& operator<<(const wxString& s);
-    wxTextCtrl& operator<<(int i);
-    wxTextCtrl& operator<<(long i);
-    wxTextCtrl& operator<<(float f);
-    wxTextCtrl& operator<<(double d);
-    wxTextCtrl& operator<<(const char c);
+    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();
+
+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);

 
 

-    virtual GtkWidget* GetConnectWidget(void);
-    

 private:
 private:

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

 
 

-  GtkWidget *m_text;
+    GtkWidget  *m_text;
+    GtkWidget  *m_vScrollbar;
+
+    bool        m_modified:1;
+    bool        m_vScrollbarVisible:1;
+    bool        m_updateFont:1;
+    bool        m_ignoreNextUpdate:1;
+
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxTextCtrl);

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

-