Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/listbox.h b/include/wx/gtk/listbox.h
index badca50a2cc53f65b9ce8b534b2828afb0d3fdc5..038a53464b86920e535e933f1a66fabe13f9dd1a 100644 (file)
--- a/include/wx/gtk/listbox.h
+++ b/include/wx/gtk/listbox.h
@@ -1,110 +1,138 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        listbox.h
-// Purpose:
+// Name:        wx/gtk/listbox.h
+// Purpose:     wxListBox class declaration

 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_LISTBOX_H_
+#define _WX_GTK_LISTBOX_H_

 
 

-#ifndef __GTKLISTBOXH__
-#define __GTKLISTBOXH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
+struct _GtkTreeEntry;
+struct _GtkTreeIter;

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

-// classes
+// wxListBox

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

-class wxListBox;
-class wxArrayInt;
+class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
+{
+public:
+    // ctors and such
+    wxListBox()
+    {
+        Init();
+    }
+    wxListBox( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            int n = 0, const wxString choices[] = (const wxString *) NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxListBoxNameStr )
+    {
+        Init();
+        Create(parent, id, pos, size, n, choices, style, validator, name);
+    }
+    wxListBox( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxListBoxNameStr )
+    {
+        Init();
+        Create(parent, id, pos, size, choices, style, validator, name);
+    }
+    virtual ~wxListBox();

 
 

-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                int n = 0, const wxString choices[] = (const wxString *) NULL,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);

 
 

-extern const char *wxListBoxNameStr;
+    virtual unsigned int GetCount() const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& s);
+    virtual int FindString(const wxString& s, bool bCase = false) const;

 
 

-//-----------------------------------------------------------------------------
-// wxListBox
-//-----------------------------------------------------------------------------
+    virtual bool IsSelected(int n) const;
+    virtual int GetSelection() const;
+    virtual int GetSelections(wxArrayInt& aSelections) const;

 
 

-class wxListBox : public wxControl
-{
-  DECLARE_DYNAMIC_CLASS(wxListBox)
+    virtual void EnsureVisible(int n);

 
 

-public:
+    virtual void Update();
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+    // implementation from now on
+
+    virtual GtkWidget *GetConnectWidget();
+
+    struct _GtkTreeView   *m_treeview;
+    struct _GtkListStore  *m_liststore;
+
+#if wxUSE_CHECKLISTBOX
+    bool       m_hasCheckBoxes;
+#endif // wxUSE_CHECKLISTBOX
+
+    struct _GtkTreeEntry* GTKGetEntry(unsigned pos) const;
+
+    void GTKDisableEvents();
+    void GTKEnableEvents();
+
+    void GTKOnSelectionChanged();
+    void GTKOnActivated(int item);
+
+protected:
+    virtual void DoClear();
+    virtual void DoDeleteOneItem(unsigned int n);
+    virtual wxSize DoGetBestSize() const;
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+
+    virtual void DoSetSelection(int n, bool select);
+
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData, wxClientDataType type);
+
+    virtual void DoSetFirstItem(int n);
+    virtual void DoSetItemClientData(unsigned int n, void* clientData);
+    virtual void* DoGetItemClientData(unsigned int n) const;
+    virtual int DoListHitTest(const wxPoint& point) const;
+
+    // get the iterator for the given index, returns false if invalid
+    bool GTKGetIteratorFor(unsigned pos, _GtkTreeIter *iter) const;
+
+    // get the index for the given iterator, return wxNOT_FOUND on failure
+    int GTKGetIndexFor(_GtkTreeIter& iter) const;
+
+    // set the specified item
+    void GTKSetItem(_GtkTreeIter& iter, const _GtkTreeEntry *entry);
+
+    // common part of DoSetFirstItem() and EnsureVisible()
+    void DoScrollToCell(int n, float alignY, float alignX);
+
+private:
+    void Init(); //common construction

 
 

-  wxListBox();
-  inline wxListBox( wxWindow *parent, wxWindowID id,
-                    const wxPoint& pos = wxDefaultPosition,
-                    const wxSize& size = wxDefaultSize,
-                    int n = 0, const wxString choices[] = (const wxString *) NULL,
-                    long style = 0,
-                    const wxValidator& validator = wxDefaultValidator,
-                   const wxString& name = wxListBoxNameStr )
-  {
-      m_hasCheckBoxes = FALSE;
-      Create(parent, id, pos, size, n, choices, style, validator, name);
-  }
-  ~wxListBox();
-  bool Create( wxWindow *parent, wxWindowID id,
-               const wxPoint& pos = wxDefaultPosition,
-               const wxSize& size = wxDefaultSize,
-               int n = 0, const wxString choices[] = (const wxString *) NULL,
-               long style = 0,
-               const wxValidator& validator = wxDefaultValidator,
-               const wxString& name = wxListBoxNameStr );
-              
-  void Append( const wxString &item );
-  void Append( const wxString &item, void* clientData );
-  void Append( const wxString &item, wxClientData* clientData );
-  
-  void SetClientData( int n, void* clientData );
-  void* GetClientData( int n );
-  void SetClientObject( int n, wxClientData* clientData );
-  wxClientData* GetClientObject( int n );
-              
-  void Clear();
-  void Delete( int n );
-  
-  void Deselect( int n );
-  int FindString( const wxString &item ) const;
-  int GetSelection(void) const;
-  int GetSelections( class wxArrayInt &) const;
-  wxString GetString( int n ) const;
-  wxString GetStringSelection(void) const;
-  int Number();
-  bool Selected( int n );
-  void Set( int n, const wxString *choices );
-  void SetFirstItem( int n );
-  void SetFirstItem( const wxString &item );
-  void SetSelection( int n, bool select = TRUE );
-  void SetString( int n, const wxString &string );
-  void SetStringSelection( const wxString &string, bool select = TRUE );
-    
-  void SetDropTarget( wxDropTarget *dropTarget );
-
-// implementation
-    
-  void AppendCommon( const wxString &item );
-  int GetIndex( GtkWidget *item ) const;
-  GtkWidget *GetConnectWidget();
-  bool IsOwnGtkWindow( GdkWindow *window );
-  void ApplyWidgetStyle();
-    
-  GtkList   *m_list;
-  wxList     m_clientDataList;
-  wxList     m_clientObjectList;
-  bool       m_hasCheckBoxes;
+    DECLARE_DYNAMIC_CLASS(wxListBox)

 };
 
 };
 

-#endif // __GTKLISTBOXH__
+#endif // _WX_GTK_LISTBOX_H_