Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/textctrl.h b/include/wx/gtk/textctrl.h
index fd5fb376c0a25bc5f536a33102c70e45ca72a047..5db8cb09e77e4fd1a0b21e1292aeec4f9de3e037 100644 (file)
--- a/include/wx/gtk/textctrl.h
+++ b/include/wx/gtk/textctrl.h
@@ -8,8 +8,10 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKTEXTCTRLH__
-#define __GTKTEXTCTRLH__
+#ifndef _WX_GTK_TEXTCTRL_H_
+#define _WX_GTK_TEXTCTRL_H_
+
+typedef struct _GtkTextMark GtkTextMark;

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


@@ -42,6 +44,7 @@ public:
     // implement base class pure virtuals
     // ----------------------------------
 
     // implement base class pure virtuals
     // ----------------------------------
 

+    virtual void WriteText(const wxString& text);

     virtual wxString GetValue() const;
     virtual bool IsEmpty() const;
 
     virtual wxString GetValue() const;
     virtual bool IsEmpty() const;
 


@@ -52,31 +55,15 @@ 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);
 

-    // sets/clears the dirty flag

     virtual void MarkDirty();
     virtual void DiscardEdits();
 
     virtual void MarkDirty();
     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);
     virtual bool SetStyle(long start, long end, const wxTextAttr& style);

+    virtual bool GetStyle(long position, 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
 
     // 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


@@ -99,22 +86,16 @@ public:
     virtual void Cut();
     virtual void Paste();
 
     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 wxTextPos GetLastPosition() const;
 
     virtual void SetSelection(long from, long to);
     virtual void SetEditable(bool editable);
 
     virtual long GetInsertionPoint() const;
     virtual wxTextPos GetLastPosition() const;
 
     virtual void SetSelection(long from, long to);
     virtual void SetEditable(bool editable);
 

+    // Overridden wxWindow methods
+    virtual void SetWindowStyleFlag( long style );

     virtual bool Enable( bool enable = true );
 
     // Implementation from now on
     virtual bool Enable( bool enable = true );
 
     // Implementation from now on


@@ -141,18 +122,8 @@ public:
 
     void SetUpdateFont(bool WXUNUSED(update)) { }
 
 
     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
 
     // 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(int n = 1) { m_countUpdatesToIgnore = n; }
 
     // tell the control to ignore next text changed signal
     void IgnoreNextTextUpdate(int n = 1) { m_countUpdatesToIgnore = n; }
 


@@ -173,16 +144,16 @@ public:
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 

-    // has the control been frozen by Freeze()?
-    bool IsFrozen() const { return m_frozenness > 0; }
-

 protected:
 protected:

+    // overridden wxWindow virtual methods

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

-    // common part of all ctors
-    void Init();
+    virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
+
+    virtual void DoFreeze();
+    virtual void DoThaw();

 
     // Widgets that use the style->base colour for the BG colour should
     // override this and return true.
 
     // Widgets that use the style->base colour for the BG colour should
     // override this and return true.


@@ -190,7 +161,29 @@ protected:
 
     virtual void DoSetValue(const wxString &value, int flags = 0);
 
 
     virtual void DoSetValue(const wxString &value, int flags = 0);
 

+    // Override this to use either GtkEntry or GtkTextView IME depending on the
+    // kind of control we are.
+    virtual int GTKIMFilterKeypress(GdkEventKey* event) const;
+
+    virtual wxPoint DoPositionToCoords(long pos) const;
+
+    // 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:

+    void Init();
+
+    // overridden wxTextEntry virtual methods
+    virtual GtkEditable *GetEditable() const;
+    virtual GtkEntry *GetEntry() 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();
 


@@ -200,7 +193,17 @@ private:
     // encoding
     wxFontEncoding GetTextEncoding() const;
 
     // 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() ? static_cast<void *>(m_buffer)
+                             : static_cast<void *>(m_text);
+    }

 
 

+
+    // the widget used for single line controls

     GtkWidget  *m_text;
 
     bool        m_modified:1;
     GtkWidget  *m_text;
 
     bool        m_modified:1;


@@ -209,20 +212,17 @@ private:
     int         m_countUpdatesToIgnore;
 
     // Our text buffer. Convenient, and holds the buffer while using
     int         m_countUpdatesToIgnore;
 
     // Our text buffer. Convenient, and holds the buffer while using

-    // a dummy one when m_frozenness > 0
+    // a dummy one when frozen

     GtkTextBuffer *m_buffer;
 
     GtkTextBuffer *m_buffer;
 

-    // number of calls to Freeze() minus number of calls to Thaw()
-    unsigned int m_frozenness;
+    GtkTextMark* m_showPositionOnThaw;
+    GSList* m_anonymousMarkList;

 
     // For wxTE_AUTO_URL
     void OnUrlMouseEvent(wxMouseEvent&);
 
     // For wxTE_AUTO_URL
     void OnUrlMouseEvent(wxMouseEvent&);

-    GdkCursor *m_gdkHandCursor;
-    GdkCursor *m_gdkXTermCursor;

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

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