OS/2 scrolling support

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

diff --git a/include/wx/generic/treectlg.h b/include/wx/generic/treectlg.h
index 4d48f81cde1220ebad88e95b9ff9965f2d0424ff..df8adb4c6e5be2d13e9bbcdaa9e91467360e2d77 100644 (file)
--- a/include/wx/generic/treectlg.h
+++ b/include/wx/generic/treectlg.h
@@ -13,19 +13,13 @@
 #define _GENERIC_TREECTRL_H_
 
 #ifdef __GNUG__
 #define _GENERIC_TREECTRL_H_
 
 #ifdef __GNUG__

-    #pragma interface "treectrg.h"
+    #pragma interface "treectlg.h"

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/string.h"
-#include "wx/object.h"
-#include "wx/event.h"
+#if wxUSE_TREECTRL
+

 #include "wx/scrolwin.h"
 #include "wx/scrolwin.h"

-#include "wx/textctrl.h"

 #include "wx/pen.h"
 #include "wx/pen.h"

-#include "wx/dynarray.h"
-#include "wx/timer.h"
-#include "wx/treebase.h"

 
 // -----------------------------------------------------------------------------
 // forward declaration
 
 // -----------------------------------------------------------------------------
 // forward declaration


@@ -53,10 +47,11 @@ public:
     wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = -1,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
     wxGenericTreeCtrl(wxWindow *parent, wxWindowID id = -1,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,

-               long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
+               long style = wxTR_DEFAULT_STYLE,

                const wxValidator &validator = wxDefaultValidator,
                const wxString& name = wxTreeCtrlNameStr)
     {
                const wxValidator &validator = wxDefaultValidator,
                const wxString& name = wxTreeCtrlNameStr)
     {

+        Init();

         Create(parent, id, pos, size, style, validator, name);
     }
 
         Create(parent, id, pos, size, style, validator, name);
     }
 


@@ -65,7 +60,7 @@ public:
     bool Create(wxWindow *parent, wxWindowID id = -1,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
     bool Create(wxWindow *parent, wxWindowID id = -1,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
+                long style = wxTR_DEFAULT_STYLE,

                 const wxValidator &validator = wxDefaultValidator,
                 const wxString& name = wxTreeCtrlNameStr);
 
                 const wxValidator &validator = wxDefaultValidator,
                 const wxString& name = wxTreeCtrlNameStr);
 


@@ -86,9 +81,11 @@ public:
     void SetSpacing(unsigned int spacing);
 
         // image list: these functions allow to associate an image list with
     void SetSpacing(unsigned int spacing);
 
         // image list: these functions allow to associate an image list with

-        // the control and retrieve it. Note that the control does _not_ delete
+        // the control and retrieve it. Note that when assigned with
+        // SetImageList, the control does _not_ delete

         // the associated image list when it's deleted in order to allow image
         // the associated image list when it's deleted in order to allow image

-        // lists to be shared between different controls.
+        // lists to be shared between different controls. If you use
+        // AssignImageList, the control _does_ delete the image list.

         //
         // The normal image list is for the icons which correspond to the
         // normal tree item state (whether it is selected or not).
         //
         // The normal image list is for the icons which correspond to the
         // normal tree item state (whether it is selected or not).


@@ -97,16 +94,21 @@ public:
         // checked/unchecked) which are taken from the state image list.
     wxImageList *GetImageList() const;
     wxImageList *GetStateImageList() const;
         // checked/unchecked) which are taken from the state image list.
     wxImageList *GetImageList() const;
     wxImageList *GetStateImageList() const;

+    wxImageList *GetButtonsImageList() const;

 
     void SetImageList(wxImageList *imageList);
     void SetStateImageList(wxImageList *imageList);
 
     void SetImageList(wxImageList *imageList);
     void SetStateImageList(wxImageList *imageList);

+    void SetButtonsImageList(wxImageList *imageList);
+    void AssignImageList(wxImageList *imageList);
+    void AssignStateImageList(wxImageList *imageList);
+    void AssignButtonsImageList(wxImageList *imageList);

 
     // Functions to work with tree ctrl items.
 
     // accessors
     // ---------
 
 
     // Functions to work with tree ctrl items.
 
     // accessors
     // ---------
 

-        // retrieve items label
+        // retrieve item's label

     wxString GetItemText(const wxTreeItemId& item) const;
         // get one of the images associated with the item (normal by default)
     int GetItemImage(const wxTreeItemId& item,
     wxString GetItemText(const wxTreeItemId& item) const;
         // get one of the images associated with the item (normal by default)
     int GetItemImage(const wxTreeItemId& item,


@@ -117,7 +119,7 @@ public:
     // modifiers
     // ---------
 
     // modifiers
     // ---------
 

-        // set items label
+        // set item's label

     void SetItemText(const wxTreeItemId& item, const wxString& text);
         // get one of the images associated with the item (normal by default)
     void SetItemImage(const wxTreeItemId& item, int image,
     void SetItemText(const wxTreeItemId& item, const wxString& text);
         // get one of the images associated with the item (normal by default)
     void SetItemImage(const wxTreeItemId& item, int image,


@@ -134,15 +136,22 @@ public:
         // the item will be shown in bold
     void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
 
         // the item will be shown in bold
     void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
 

-        // set the items text colour
+        // set the item's text colour

     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
 
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
 

-        // set the items background colour
+        // set the item's background colour

     void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
 
     void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col);
 

-        // set the items font (should be of the same height for all items)
+        // set the item's font (should be of the same height for all items)

     void SetItemFont(const wxTreeItemId& item, const wxFont& font);
 
     void SetItemFont(const wxTreeItemId& item, const wxFont& font);
 

+        // set the window font
+    virtual bool SetFont( const wxFont &font );
+
+       // set the styles.  No need to specify a GetWindowStyle here since
+       // the base wxWindow member function will do it for us
+    void SetWindowStyle(const long styles);
+

     // item status inquiries
     // ---------------------
 
     // item status inquiries
     // ---------------------
 


@@ -158,6 +167,7 @@ public:
     bool IsSelected(const wxTreeItemId& item) const;
         // is item text in bold font?
     bool IsBold(const wxTreeItemId& item) const;
     bool IsSelected(const wxTreeItemId& item) const;
         // is item text in bold font?
     bool IsBold(const wxTreeItemId& item) const;

+        // does the layout include space for a button?

 
     // number of children
     // ------------------
 
     // number of children
     // ------------------


@@ -210,6 +220,9 @@ public:
         // get the previous visible item: item must be visible itself!
     wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 
         // get the previous visible item: item must be visible itself!
     wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 

+        // Only for internal use right now, but should probably be public
+    wxTreeItemId GetNext(const wxTreeItemId& item) const;
+

     // operations
     // ----------
 
     // operations
     // ----------
 


@@ -274,6 +287,7 @@ public:
     void EnsureVisible(const wxTreeItemId& item);
         // scroll to this item (but don't expand its parent)
     void ScrollTo(const wxTreeItemId& item);
     void EnsureVisible(const wxTreeItemId& item);
         // scroll to this item (but don't expand its parent)
     void ScrollTo(const wxTreeItemId& item);

+    void AdjustMyScrollbars();

 
         // The first function is more portable (because easier to implement
         // on other platforms), but the second one returns some extra info.
 
         // The first function is more portable (because easier to implement
         // on other platforms), but the second one returns some extra info.


@@ -281,6 +295,11 @@ public:
         { int dummy; return HitTest(point, dummy); }
     wxTreeItemId HitTest(const wxPoint& point, int& flags);
 
         { int dummy; return HitTest(point, dummy); }
     wxTreeItemId HitTest(const wxPoint& point, int& flags);
 

+        // get the bounding rectangle of the item (or of its label only)
+    bool GetBoundingRect(const wxTreeItemId& item,
+                         wxRect& rect,
+                         bool textOnly = FALSE) const;
+

         // Start editing the item label: this (temporarily) replaces the item
         // with a one line edit control. The item will be selected if it hadn't
         // been before.
         // Start editing the item label: this (temporarily) replaces the item
         // with a one line edit control. The item will be selected if it hadn't
         // been before.


@@ -309,6 +328,10 @@ public:
 
     // implementation only from now on
 
 
     // implementation only from now on
 

+    // overridden base class virtuals
+    virtual bool SetBackgroundColour(const wxColour& colour);
+    virtual bool SetForegroundColour(const wxColour& colour);
+

     // callbacks
     void OnPaint( wxPaintEvent &event );
     void OnSetFocus( wxFocusEvent &event );
     // callbacks
     void OnPaint( wxPaintEvent &event );
     void OnSetFocus( wxFocusEvent &event );


@@ -333,28 +356,34 @@ protected:
 
     wxGenericTreeItem   *m_anchor;
     wxGenericTreeItem   *m_current, *m_key_current, *m_currentEdit;
 
     wxGenericTreeItem   *m_anchor;
     wxGenericTreeItem   *m_current, *m_key_current, *m_currentEdit;

-    bool                 m_hasFocus;
-    bool                 m_dirty;
-    int                  m_xScroll,m_yScroll;
-    unsigned int         m_indent;
-    unsigned int         m_spacing;
+    unsigned short       m_indent;
+    unsigned short       m_spacing;

     int                  m_lineHeight;
     wxPen                m_dottedPen;
     int                  m_lineHeight;
     wxPen                m_dottedPen;

-    wxBrush             *m_hilightBrush;
+    wxBrush             *m_hilightBrush,
+                        *m_hilightUnfocusedBrush;
+    bool                 m_hasFocus;
+    bool                 m_dirty;
+    bool                 m_ownsImageListNormal,
+                         m_ownsImageListState,
+                         m_ownsImageListButtons;
+    bool                 m_isDragging; // true between BEGIN/END drag events
+    bool                 m_renameAccept;
+    bool                 m_lastOnSame;  // last click on the same item as prev

     wxImageList         *m_imageListNormal,
     wxImageList         *m_imageListNormal,

-                        *m_imageListState;
+                        *m_imageListState,
+                        *m_imageListButtons;

 
     int                  m_dragCount;
     wxPoint              m_dragStart;
 
     int                  m_dragCount;
     wxPoint              m_dragStart;

-    bool                 m_isDragging; // true between BEGIN/END drag events

     wxGenericTreeItem   *m_dropTarget;
     wxCursor             m_oldCursor;  // cursor is changed while dragging
     wxGenericTreeItem   *m_oldSelection;
 
     wxTimer             *m_renameTimer;
     wxGenericTreeItem   *m_dropTarget;
     wxCursor             m_oldCursor;  // cursor is changed while dragging
     wxGenericTreeItem   *m_oldSelection;
 
     wxTimer             *m_renameTimer;

-    bool                 m_renameAccept;
-    bool                 m_lastOnSame;  // last click on the same item as prev

     wxString             m_renameRes;
     wxString             m_renameRes;

+    
+    wxBitmap            *m_arrowRight,*m_arrowDown;

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


@@ -365,8 +394,12 @@ protected:
                               const wxString& text,
                               int image, int selectedImage,
                               wxTreeItemData *data);
                               const wxString& text,
                               int image, int selectedImage,
                               wxTreeItemData *data);

+    bool HasButtons(void) const
+        { return (m_imageListButtons != NULL)
+              || HasFlag(wxTR_TWIST_BUTTONS|wxTR_HAS_BUTTONS); }

 
 

-    void AdjustMyScrollbars();
+protected:
+    void CalculateLineHeight();

     int  GetLineHeight(wxGenericTreeItem *item) const;
     void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
     void PaintItem( wxGenericTreeItem *item, wxDC& dc);
     int  GetLineHeight(wxGenericTreeItem *item) const;
     void PaintLevel( wxGenericTreeItem *item, wxDC& dc, int level, int &y );
     void PaintItem( wxGenericTreeItem *item, wxDC& dc);


@@ -378,6 +411,12 @@ protected:
     void RefreshSubtree( wxGenericTreeItem *item );
     void RefreshLine( wxGenericTreeItem *item );
 
     void RefreshSubtree( wxGenericTreeItem *item );
     void RefreshLine( wxGenericTreeItem *item );
 

+    // redraw all selected items
+    void RefreshSelected();
+
+    // RefreshSelected() recursive helper
+    void RefreshSelectedUnder(wxGenericTreeItem *item);
+

     void OnRenameTimer();
     void OnRenameAccept();
 
     void OnRenameTimer();
     void OnRenameAccept();
 


@@ -394,5 +433,32 @@ private:
     DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
 };
 
     DECLARE_DYNAMIC_CLASS(wxGenericTreeCtrl)
 };
 

+#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__)
+/*
+ * wxTreeCtrl has to be a real class or we have problems with
+ * the run-time information.
+ */
+
+class WXDLLEXPORT wxTreeCtrl: public wxGenericTreeCtrl
+{
+    DECLARE_DYNAMIC_CLASS(wxTreeCtrl)
+
+public:
+    wxTreeCtrl() {}
+
+    wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
+               const wxPoint& pos = wxDefaultPosition,
+               const wxSize& size = wxDefaultSize,
+               long style = wxTR_DEFAULT_STYLE,
+               const wxValidator &validator = wxDefaultValidator,
+               const wxString& name = wxTreeCtrlNameStr)
+    : wxGenericTreeCtrl(parent, id, pos, size, style, validator, name)
+    {
+    }
+};
+#endif // !__WXMSW__ || __WIN16__ || __WXUNIVERSAL__
+
+#endif // wxUSE_TREECTRL
+

 #endif // _GENERIC_TREECTRL_H_
 
 #endif // _GENERIC_TREECTRL_H_