Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / generic / treectlg.h

diff --git a/include/wx/generic/treectlg.h b/include/wx/generic/treectlg.h
index 98bc85666abd80cd24478d0f34590a2a39175cb3..168247c91cf81e052a945fa587ee53ef298c5732 100644 (file)
--- a/include/wx/generic/treectlg.h
+++ b/include/wx/generic/treectlg.h
@@ -65,7 +65,6 @@ public:
                 const wxValidator &validator = wxDefaultValidator,
                 const wxString& name = wxTreeCtrlNameStr);
 
                 const wxValidator &validator = wxDefaultValidator,
                 const wxString& name = wxTreeCtrlNameStr);
 

-

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


@@ -122,6 +121,9 @@ public:
     virtual size_t GetSelections(wxArrayTreeItemIds&) const;
     virtual wxTreeItemId GetFocusedItem() const { return m_current; }
 
     virtual size_t GetSelections(wxArrayTreeItemIds&) const;
     virtual wxTreeItemId GetFocusedItem() const { return m_current; }
 

+    virtual void ClearFocusedItem();
+    virtual void SetFocusedItem(const wxTreeItemId& item);
+

     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
                                        wxTreeItemIdValue& cookie) const;
     virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
     virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item,
                                        wxTreeItemIdValue& cookie) const;


@@ -155,16 +157,19 @@ public:
     virtual void Unselect();
     virtual void UnselectAll();
     virtual void SelectItem(const wxTreeItemId& item, bool select = true);
     virtual void Unselect();
     virtual void UnselectAll();
     virtual void SelectItem(const wxTreeItemId& item, bool select = true);

+    virtual void SelectChildren(const wxTreeItemId& parent);

 
     virtual void EnsureVisible(const wxTreeItemId& item);
     virtual void ScrollTo(const wxTreeItemId& item);
 
     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,
 
     virtual void EnsureVisible(const wxTreeItemId& item);
     virtual void ScrollTo(const wxTreeItemId& item);
 
     virtual wxTextCtrl *EditLabel(const wxTreeItemId& item,

-                          wxClassInfo* textCtrlClass = CLASSINFO(wxTextCtrl));
+                          wxClassInfo* textCtrlClass = wxCLASSINFO(wxTextCtrl));

     virtual wxTextCtrl *GetEditControl() const;
     virtual void EndEditLabel(const wxTreeItemId& item,
                               bool discardChanges = false);
 
     virtual wxTextCtrl *GetEditControl() const;
     virtual void EndEditLabel(const wxTreeItemId& item,
                               bool discardChanges = false);
 

+    virtual void EnableBellOnNoMatch(bool on = true);
+

     virtual void SortChildren(const wxTreeItemId& item);
 
     // items geometry
     virtual void SortChildren(const wxTreeItemId& item);
 
     // items geometry


@@ -207,6 +212,7 @@ public:
     void OnPaint( wxPaintEvent &event );
     void OnSetFocus( wxFocusEvent &event );
     void OnKillFocus( wxFocusEvent &event );
     void OnPaint( wxPaintEvent &event );
     void OnSetFocus( wxFocusEvent &event );
     void OnKillFocus( wxFocusEvent &event );

+    void OnKeyDown( wxKeyEvent &event );

     void OnChar( wxKeyEvent &event );
     void OnMouse( wxMouseEvent &event );
     void OnGetToolTip( wxTreeEvent &event );
     void OnChar( wxKeyEvent &event );
     void OnMouse( wxMouseEvent &event );
     void OnGetToolTip( wxTreeEvent &event );


@@ -258,25 +264,29 @@ protected:
     wxCursor             m_oldCursor;  // cursor is changed while dragging
     wxGenericTreeItem   *m_oldSelection;
     wxGenericTreeItem   *m_underMouse; // for visual effects
     wxCursor             m_oldCursor;  // cursor is changed while dragging
     wxGenericTreeItem   *m_oldSelection;
     wxGenericTreeItem   *m_underMouse; // for visual effects

-    
+

     enum { NoEffect, BorderEffect, AboveEffect, BelowEffect } m_dndEffect;
     enum { NoEffect, BorderEffect, AboveEffect, BelowEffect } m_dndEffect;

-    wxGenericTreeItem   *m_dndEffectItem; 
-    
+    wxGenericTreeItem   *m_dndEffectItem;
+

     wxTreeTextCtrl      *m_textCtrl;
     wxTreeTextCtrl      *m_textCtrl;

-    
+

 
     wxTimer             *m_renameTimer;
 
     // incremental search data
     wxString             m_findPrefix;
     wxTimer             *m_findTimer;
 
     wxTimer             *m_renameTimer;
 
     // incremental search data
     wxString             m_findPrefix;
     wxTimer             *m_findTimer;

+    // This flag is set to 0 if the bell is disabled, 1 if it is enabled and -1
+    // if it is globally enabled but has been temporarily disabled because we
+    // had already beeped for this particular search.
+    int                  m_findBell;

 
     bool                 m_dropEffectAboveItem;
 
     // the common part of all ctors
     void Init();
 
 
     bool                 m_dropEffectAboveItem;
 
     // the common part of all ctors
     void Init();
 

-    // overridden wxWindow methods 
+    // overridden wxWindow methods

     virtual void DoThaw();
 
     // misc helpers
     virtual void DoThaw();
 
     // misc helpers


@@ -347,6 +357,10 @@ protected:
     virtual wxSize DoGetBestSize() const;
 
 private:
     virtual wxSize DoGetBestSize() const;
 
 private:

+    // Reset the state of the last find (i.e. keyboard incremental search)
+    // operation.
+    void ResetFindState();
+

     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
     wxDECLARE_NO_COPY_CLASS(wxGenericTreeCtrl);
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
     wxDECLARE_NO_COPY_CLASS(wxGenericTreeCtrl);