replace @b Note with @note; replace '' with "

[wxWidgets.git] / src / generic / treectlg.cpp

diff --git a/src/generic/treectlg.cpp b/src/generic/treectlg.cpp
index 800e58ad60f36bbc2f928a4de5a7d4c03efcdb43..2ac26238faca5042056fb78abe8b610e819a8172 100644 (file)
--- a/src/generic/treectlg.cpp
+++ b/src/generic/treectlg.cpp
@@ -51,7 +51,7 @@
 
 class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem;
 
 
 class WXDLLIMPEXP_FWD_CORE wxGenericTreeItem;
 

-WX_DEFINE_EXPORTED_ARRAY_PTR(wxGenericTreeItem *, wxArrayGenericTreeItems);
+WX_DEFINE_ARRAY_PTR(wxGenericTreeItem *, wxArrayGenericTreeItems);

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -92,29 +92,8 @@ class WXDLLEXPORT wxTreeTextCtrl: public wxTextCtrl
 public:
     wxTreeTextCtrl(wxGenericTreeCtrl *owner, wxGenericTreeItem *item);
 
 public:
     wxTreeTextCtrl(wxGenericTreeCtrl *owner, wxGenericTreeItem *item);
 

-    void EndEdit(bool discardChanges = false)
-    {
-        if ( discardChanges )
-        {
-            StopEditing();
-        }
-        else
-        {
-            m_aboutToFinish = true;
-
-            // Notify the owner about the changes
-            AcceptChanges();
-
-            // Even if vetoed, close the control (consistent with MSW)
-            Finish();
-        }
-    }
+    void EndEdit( bool discardChanges );

 
 

-    void StopEditing()
-    {
-        Finish();
-        m_owner->OnRenameCancelled(m_itemEdited);
-    }

     const wxGenericTreeItem* item() const { return m_itemEdited; }
 
 protected:
     const wxGenericTreeItem* item() const { return m_itemEdited; }
 
 protected:


@@ -123,13 +102,12 @@ protected:
     void OnKillFocus( wxFocusEvent &event );
 
     bool AcceptChanges();
     void OnKillFocus( wxFocusEvent &event );
 
     bool AcceptChanges();

-    void Finish();
+    void Finish( bool setfocus );

 
 private:
     wxGenericTreeCtrl  *m_owner;
     wxGenericTreeItem  *m_itemEdited;
     wxString            m_startValue;
 
 private:
     wxGenericTreeCtrl  *m_owner;
     wxGenericTreeItem  *m_itemEdited;
     wxString            m_startValue;

-    bool                m_finished;

     bool                m_aboutToFinish;
 
     DECLARE_EVENT_TABLE()
     bool                m_aboutToFinish;
 
     DECLARE_EVENT_TABLE()


@@ -363,7 +341,6 @@ wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl *owner,
               : m_itemEdited(item), m_startValue(item->GetText())
 {
     m_owner = owner;
               : m_itemEdited(item), m_startValue(item->GetText())
 {
     m_owner = owner;

-    m_finished = false;

     m_aboutToFinish = false;
 
     int w = m_itemEdited->GetWidth(),
     m_aboutToFinish = false;
 
     int w = m_itemEdited->GetWidth(),


@@ -407,6 +384,26 @@ wxTreeTextCtrl::wxTreeTextCtrl(wxGenericTreeCtrl *owner,
                  wxPoint(x - 4, y - 4), wxSize(w + 11, h + 8));
 }
 
                  wxPoint(x - 4, y - 4), wxSize(w + 11, h + 8));
 }
 

+void wxTreeTextCtrl::EndEdit(bool discardChanges)
+{
+    m_aboutToFinish = true;
+
+    if ( discardChanges )
+    {
+        m_owner->OnRenameCancelled(m_itemEdited);
+
+        Finish( true );
+    }
+    else
+    {
+        // Notify the owner about the changes
+        AcceptChanges();
+
+        // Even if vetoed, close the control (consistent with MSW)
+        Finish( true );
+    }
+}
+

 bool wxTreeTextCtrl::AcceptChanges()
 {
     const wxString value = GetValue();
 bool wxTreeTextCtrl::AcceptChanges()
 {
     const wxString value = GetValue();


@@ -435,18 +432,14 @@ bool wxTreeTextCtrl::AcceptChanges()
     return true;
 }
 
     return true;
 }
 

-void wxTreeTextCtrl::Finish()
+void wxTreeTextCtrl::Finish( bool setfocus )

 {
 {

-    if ( !m_finished  )
-    {
-        m_owner->ResetTextControl();
-
-        wxPendingDelete.Append(this);
+    m_owner->ResetTextControl();

 
 

-        m_finished = true;
+    wxPendingDelete.Append(this);

 
 

+    if (setfocus)

         m_owner->SetFocus();
         m_owner->SetFocus();

-    }

 }
 
 void wxTreeTextCtrl::OnChar( wxKeyEvent &event )
 }
 
 void wxTreeTextCtrl::OnChar( wxKeyEvent &event )


@@ -454,11 +447,11 @@ void wxTreeTextCtrl::OnChar( wxKeyEvent &event )
     switch ( event.m_keyCode )
     {
         case WXK_RETURN:
     switch ( event.m_keyCode )
     {
         case WXK_RETURN:

-            EndEdit();
+            EndEdit( false );

             break;
 
         case WXK_ESCAPE:
             break;
 
         case WXK_ESCAPE:

-            StopEditing();
+            EndEdit( true );

             break;
 
         default:
             break;
 
         default:


@@ -468,7 +461,7 @@ void wxTreeTextCtrl::OnChar( wxKeyEvent &event )
 
 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent &event )
 {
 
 void wxTreeTextCtrl::OnKeyUp( wxKeyEvent &event )
 {

-    if ( !m_finished )
+    if ( !m_aboutToFinish )

     {
         // auto-grow the textctrl:
         wxSize parentSize = m_owner->GetSize();
     {
         // auto-grow the textctrl:
         wxSize parentSize = m_owner->GetSize();


@@ -488,18 +481,15 @@ void wxTreeTextCtrl::OnKeyUp( wxKeyEvent &event )
 
 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent &event )
 {
 
 void wxTreeTextCtrl::OnKillFocus( wxFocusEvent &event )
 {

-    if ( !m_finished && !m_aboutToFinish )
+    if ( !m_aboutToFinish )

     {
     {

-        // We must finish regardless of success, otherwise we'll get
-        // focus problems:
-        Finish();
-

         if ( !AcceptChanges() )
             m_owner->OnRenameCancelled( m_itemEdited );
         if ( !AcceptChanges() )
             m_owner->OnRenameCancelled( m_itemEdited );

+
+        Finish( false );

     }
 
     }
 

-    // We must let the native text control handle focus, too, otherwise
-    // it could have problems with the cursor (e.g., in wxGTK).
+    // We should let the native text control handle focus, too.

     event.Skip();
 }
 
     event.Skip();
 }
 


@@ -760,7 +750,7 @@ void wxGenericTreeCtrl::Init()
                             (
                                 wxSYS_COLOUR_HIGHLIGHT
                             ),
                             (
                                 wxSYS_COLOUR_HIGHLIGHT
                             ),

-                            wxSOLID
+                            wxBRUSHSTYLE_SOLID

                          );
 
     m_hilightUnfocusedBrush = new wxBrush
                          );
 
     m_hilightUnfocusedBrush = new wxBrush


@@ -769,7 +759,7 @@ void wxGenericTreeCtrl::Init()
                                  (
                                      wxSYS_COLOUR_BTNSHADOW
                                  ),
                                  (
                                      wxSYS_COLOUR_BTNSHADOW
                                  ),

-                                 wxSOLID
+                                 wxBRUSHSTYLE_SOLID

                               );
 
     m_imageListButtons = NULL;
                               );
 
     m_imageListButtons = NULL;


@@ -782,7 +772,6 @@ void wxGenericTreeCtrl::Init()
     m_textCtrl = NULL;
 
     m_renameTimer = NULL;
     m_textCtrl = NULL;
 
     m_renameTimer = NULL;

-    m_freezeCount = 0;

 
     m_findTimer = NULL;
 
 
     m_findTimer = NULL;
 


@@ -790,8 +779,8 @@ void wxGenericTreeCtrl::Init()
 
     m_lastOnSame = false;
 
 
     m_lastOnSame = false;
 

-#ifdef __WXMAC_CARBON__
-    m_normalFont.MacCreateThemeFont( kThemeViewsFont ) ;
+#ifdef __WXMAC__
+    m_normalFont.MacCreateFromThemeFont( kThemeViewsFont ) ;

 #else
     m_normalFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 #endif
 #else
     m_normalFont = wxSystemSettings::GetFont( wxSYS_DEFAULT_GUI_FONT );
 #endif


@@ -813,21 +802,12 @@ bool wxGenericTreeCtrl::Create(wxWindow *parent,
                                const wxString& name )
 {
 #ifdef __WXMAC__
                                const wxString& name )
 {
 #ifdef __WXMAC__

-    int major,minor;
-    wxGetOsVersion( &major, &minor );
+    int major, minor;
+    wxGetOsVersion(&major, &minor);

 
 

-    style &= ~wxTR_LINES_AT_ROOT;
-    style |= wxTR_NO_LINES;

     if (major < 10)
         style |= wxTR_ROW_LINES;
     if (major < 10)
         style |= wxTR_ROW_LINES;

-        
-    if (style == 0 || style & wxTR_DEFAULT_STYLE)
-        style |= wxTR_FULL_ROW_HIGHLIGHT;
-        

 #endif // __WXMAC__
 #endif // __WXMAC__

-#ifdef __WXGTK20__
-    style |= wxTR_NO_LINES;
-#endif

 
     if ( !wxControl::Create( parent, id, pos, size,
                              style|wxHSCROLL|wxVSCROLL,
 
     if ( !wxControl::Create( parent, id, pos, size,
                              style|wxHSCROLL|wxVSCROLL,


@@ -850,7 +830,14 @@ bool wxGenericTreeCtrl::Create(wxWindow *parent,
     if (!m_hasFont)
         SetOwnFont(attr.font);
 
     if (!m_hasFont)
         SetOwnFont(attr.font);
 

-    m_dottedPen = wxPen( wxT("grey"), 0, 0 );
+    // this is a misnomer: it's called "dotted pen" but uses (default) wxSOLID
+    // style because we apparently get performance problems when using dotted
+    // pen for drawing in some ports -- but under MSW it seems to work fine
+#ifdef __WXMSW__
+    m_dottedPen = wxPen(*wxLIGHT_GREY, 0, wxPENSTYLE_DOT);
+#else
+    m_dottedPen = *wxGREY_PEN;
+#endif

 
     SetInitialSize(size);
 
 
     SetInitialSize(size);
 


@@ -1308,6 +1295,7 @@ wxTreeItemId wxGenericTreeCtrl::GetFirstVisibleItem() const
 wxTreeItemId wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
 {
     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
 wxTreeItemId wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
 {
     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );

+    wxASSERT_MSG( IsVisible(item), wxT("this item itself should be visible") );

 
     wxTreeItemId id = item;
     if (id.IsOk())
 
     wxTreeItemId id = item;
     if (id.IsOk())


@@ -1324,10 +1312,37 @@ wxTreeItemId wxGenericTreeCtrl::GetNextVisible(const wxTreeItemId& item) const
 wxTreeItemId wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
 {
     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );
 wxTreeItemId wxGenericTreeCtrl::GetPrevVisible(const wxTreeItemId& item) const
 {
     wxCHECK_MSG( item.IsOk(), wxTreeItemId(), wxT("invalid tree item") );

+    wxASSERT_MSG( IsVisible(item), wxT("this item itself should be visible") );

 
 

-    wxFAIL_MSG(wxT("not implemented"));
+    // find out the starting point
+    wxTreeItemId prevItem = GetPrevSibling(item);
+    if ( !prevItem.IsOk() )
+    {
+        prevItem = GetItemParent(item);
+    }

 
 

-    return wxTreeItemId();
+    // find the first visible item after it
+    while ( prevItem.IsOk() && !IsVisible(prevItem) )
+    {
+        prevItem = GetNext(prevItem);
+        if ( !prevItem.IsOk() || prevItem == item )
+        {
+            // there are no visible items before item
+            return wxTreeItemId();
+        }
+    }
+
+    // from there we must be able to navigate until this item
+    while ( prevItem.IsOk() )
+    {
+        const wxTreeItemId nextItem = GetNextVisible(prevItem);
+        if ( !nextItem.IsOk() || nextItem == item )
+            break;
+
+        prevItem = nextItem;
+    }
+
+    return prevItem;

 }
 
 // called by wxTextTreeCtrl when it marks itself for deletion
 }
 
 // called by wxTextTreeCtrl when it marks itself for deletion


@@ -1489,7 +1504,7 @@ void wxGenericTreeCtrl::SendDeleteEvent(wxGenericTreeItem *item)
 void wxGenericTreeCtrl::ChildrenClosing(wxGenericTreeItem* item)
 {
     if (m_textCtrl != NULL && item != m_textCtrl->item() && IsDescendantOf(item, m_textCtrl->item())) {
 void wxGenericTreeCtrl::ChildrenClosing(wxGenericTreeItem* item)
 {
     if (m_textCtrl != NULL && item != m_textCtrl->item() && IsDescendantOf(item, m_textCtrl->item())) {

-        m_textCtrl->StopEditing();
+        m_textCtrl->EndEdit( true );

     }
     if (item != m_key_current && IsDescendantOf(item, m_key_current)) {
         m_key_current = NULL;
     }
     if (item != m_key_current && IsDescendantOf(item, m_key_current)) {
         m_key_current = NULL;


@@ -1523,7 +1538,7 @@ void wxGenericTreeCtrl::Delete(const wxTreeItemId& itemId)
     if (m_textCtrl != NULL && IsDescendantOf(item, m_textCtrl->item()))
     {
         // can't delete the item being edited, cancel editing it first
     if (m_textCtrl != NULL && IsDescendantOf(item, m_textCtrl->item()))
     {
         // can't delete the item being edited, cancel editing it first

-        m_textCtrl->StopEditing();
+        m_textCtrl->EndEdit( true );

     }
 
     wxGenericTreeItem *parent = item->GetParent();
     }
 
     wxGenericTreeItem *parent = item->GetParent();


@@ -1611,9 +1626,16 @@ void wxGenericTreeCtrl::Expand(const wxTreeItemId& itemId)
     }
 
     item->Expand();
     }
 
     item->Expand();

-    CalculatePositions();
+    if ( !IsFrozen() )
+    {
+        CalculatePositions();

 
 

-    RefreshSubtree(item);
+        RefreshSubtree(item);
+    }
+    else // frozen
+    {
+        m_dirty = true;
+    }

 
     event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED);
     GetEventHandler()->ProcessEvent( event );
 
     event.SetEventType(wxEVT_COMMAND_TREE_ITEM_EXPANDED);
     GetEventHandler()->ProcessEvent( event );


@@ -1875,7 +1897,7 @@ void wxGenericTreeCtrl::SelectItem(const wxTreeItemId& itemId, bool select)
     {
         wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
         wxCHECK_RET( item, wxT("SelectItem(): invalid tree item") );
     {
         wxGenericTreeItem *item = (wxGenericTreeItem*) itemId.m_pItem;
         wxCHECK_RET( item, wxT("SelectItem(): invalid tree item") );

-        
+

         wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
         if ( GetEventHandler()->ProcessEvent( event ) && !event.IsAllowed() )
             return;
         wxTreeEvent event(wxEVT_COMMAND_TREE_SEL_CHANGING, this, item);
         if ( GetEventHandler()->ProcessEvent( event ) && !event.IsAllowed() )
             return;


@@ -2186,7 +2208,7 @@ void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
         {
             colBg = GetBackgroundColour();
         }
         {
             colBg = GetBackgroundColour();
         }

-        dc.SetBrush(wxBrush(colBg, wxSOLID));
+        dc.SetBrush(wxBrush(colBg, wxBRUSHSTYLE_SOLID));

     }
 
     int offset = HasFlag(wxTR_ROW_LINES) ? 1 : 0;
     }
 
     int offset = HasFlag(wxTR_ROW_LINES) ? 1 : 0;


@@ -2208,7 +2230,7 @@ void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
         {
             int flags = wxCONTROL_SELECTED;
             if (m_hasFocus
         {
             int flags = wxCONTROL_SELECTED;
             if (m_hasFocus

-#ifdef __WXMAC__
+#if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)

                 && IsControlActive( (ControlRef)GetHandle() )
 #endif
             )
                 && IsControlActive( (ControlRef)GetHandle() )
 #endif
             )


@@ -2233,7 +2255,7 @@ void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
 #else
             rect.x -= 1;
             rect.width += 2;
 #else
             rect.x -= 1;
             rect.width += 2;

-        
+

             int flags = wxCONTROL_SELECTED;
             if (m_hasFocus)
                 flags |= wxCONTROL_FOCUSED;
             int flags = wxCONTROL_SELECTED;
             if (m_hasFocus)
                 flags |= wxCONTROL_FOCUSED;


@@ -2260,7 +2282,7 @@ void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
             {
                 rect.x -= 1;
                 rect.width += 2;
             {
                 rect.x -= 1;
                 rect.width += 2;

-                
+

                 int flags = wxCONTROL_SELECTED;
                 if (m_hasFocus)
                     flags |= wxCONTROL_FOCUSED;
                 int flags = wxCONTROL_SELECTED;
                 if (m_hasFocus)
                     flags |= wxCONTROL_FOCUSED;


@@ -2282,7 +2304,7 @@ void wxGenericTreeCtrl::PaintItem(wxGenericTreeItem *item, wxDC& dc)
         dc.DestroyClippingRegion();
     }
 
         dc.DestroyClippingRegion();
     }
 

-    dc.SetBackgroundMode(wxTRANSPARENT);
+    dc.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT);

     int extraH = (total_h > text_h) ? (total_h - text_h)/2 : 0;
     dc.DrawText( item->GetText(),
                  (wxCoord)(image_w + item->GetX()),
     int extraH = (total_h > text_h) ? (total_h - text_h)/2 : 0;
     dc.DrawText( item->GetText(),
                  (wxCoord)(image_w + item->GetX()),


@@ -2348,7 +2370,7 @@ void wxGenericTreeCtrl::PaintLevel( wxGenericTreeItem *item, wxDC &dc, int level
 
         wxColour colText;
         if ( item->IsSelected()
 
         wxColour colText;
         if ( item->IsSelected()

-#ifdef __WXMAC__
+#if defined( __WXMAC__ ) && !defined(__WXUNIVERSAL__)

             // On wxMac, if the tree doesn't have the focus we draw an empty
             // rectangle, so we want to make sure that the text is visible
             // against the normal background, not the highlightbackground, so
             // On wxMac, if the tree doesn't have the focus we draw an empty
             // rectangle, so we want to make sure that the text is visible
             // against the normal background, not the highlightbackground, so


@@ -3475,13 +3497,13 @@ void wxGenericTreeCtrl::CalculatePositions()
 
 void wxGenericTreeCtrl::Refresh(bool eraseBackground, const wxRect *rect)
 {
 
 void wxGenericTreeCtrl::Refresh(bool eraseBackground, const wxRect *rect)
 {

-    if ( !m_freezeCount )
+    if ( !IsFrozen() )

         wxTreeCtrlBase::Refresh(eraseBackground, rect);
 }
 
 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem *item)
 {
         wxTreeCtrlBase::Refresh(eraseBackground, rect);
 }
 
 void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem *item)
 {

-    if (m_dirty || m_freezeCount)
+    if (m_dirty || IsFrozen() )

         return;
 
     wxSize client = GetClientSize();
         return;
 
     wxSize client = GetClientSize();


@@ -3498,7 +3520,7 @@ void wxGenericTreeCtrl::RefreshSubtree(wxGenericTreeItem *item)
 
 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem *item )
 {
 
 void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem *item )
 {

-    if (m_dirty || m_freezeCount)
+    if (m_dirty || IsFrozen() )

         return;
 
     wxRect rect;
         return;
 
     wxRect rect;


@@ -3511,7 +3533,7 @@ void wxGenericTreeCtrl::RefreshLine( wxGenericTreeItem *item )
 
 void wxGenericTreeCtrl::RefreshSelected()
 {
 
 void wxGenericTreeCtrl::RefreshSelected()
 {

-    if (m_freezeCount)
+    if (IsFrozen())

         return;
 
     // TODO: this is awfully inefficient, we should keep the list of all
         return;
 
     // TODO: this is awfully inefficient, we should keep the list of all


@@ -3522,7 +3544,7 @@ void wxGenericTreeCtrl::RefreshSelected()
 
 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem *item)
 {
 
 void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem *item)
 {

-    if (m_freezeCount)
+    if (IsFrozen())

         return;
 
     if ( item->IsSelected() )
         return;
 
     if ( item->IsSelected() )


@@ -3536,19 +3558,14 @@ void wxGenericTreeCtrl::RefreshSelectedUnder(wxGenericTreeItem *item)
     }
 }
 
     }
 }
 

-void wxGenericTreeCtrl::Freeze()
+void wxGenericTreeCtrl::DoThaw()

 {
 {

-    m_freezeCount++;
-}
-
-void wxGenericTreeCtrl::Thaw()
-{
-    wxCHECK_RET( m_freezeCount > 0, _T("thawing unfrozen tree control?") );
+    wxTreeCtrlBase::DoThaw();

 
 

-    if ( --m_freezeCount == 0 )
-    {
+    if ( m_dirty )
+        DoDirtyProcessing();
+    else

         Refresh();
         Refresh();

-    }

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -3609,7 +3626,7 @@ wxGenericTreeCtrl::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 
 void wxGenericTreeCtrl::DoDirtyProcessing()
 {
 
 void wxGenericTreeCtrl::DoDirtyProcessing()
 {

-    if (m_freezeCount)
+    if (IsFrozen())

         return;
 
     m_dirty = false;
         return;
 
     m_dirty = false;