Some doc updates.

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

diff --git a/src/generic/listctrl.cpp b/src/generic/listctrl.cpp
index 03d8c7f6101eed65d712b0fdccf7cdfc51f1919f..30ef6ea2a6c313fd6bced1f13e764bb31f078077 100644 (file)
--- a/src/generic/listctrl.cpp
+++ b/src/generic/listctrl.cpp
@@ -41,14 +41,15 @@ wxListItemData::wxListItemData()
     m_ypos = 0;
     m_width = 0;
     m_height = 0;
     m_ypos = 0;
     m_width = 0;
     m_height = 0;

-    m_colour = wxBLACK;
+    m_attr = NULL;

 }
 
 wxListItemData::wxListItemData( const wxListItem &info )
 {
     m_image = -1;
     m_data = 0;
 }
 
 wxListItemData::wxListItemData( const wxListItem &info )
 {
     m_image = -1;
     m_data = 0;

-    m_colour = info.m_colour;
+    m_attr = NULL;
+

     SetItem( info );
 }
 
     SetItem( info );
 }
 


@@ -57,7 +58,15 @@ void wxListItemData::SetItem( const wxListItem &info )
     if (info.m_mask & wxLIST_MASK_TEXT) m_text = info.m_text;
     if (info.m_mask & wxLIST_MASK_IMAGE) m_image = info.m_image;
     if (info.m_mask & wxLIST_MASK_DATA) m_data = info.m_data;
     if (info.m_mask & wxLIST_MASK_TEXT) m_text = info.m_text;
     if (info.m_mask & wxLIST_MASK_IMAGE) m_image = info.m_image;
     if (info.m_mask & wxLIST_MASK_DATA) m_data = info.m_data;

-    m_colour = info.m_colour;
+
+    if ( info.HasAttributes() )
+    {
+        if ( m_attr )
+            *m_attr = *info.GetAttributes();
+        else
+            m_attr = new wxListItemAttr(*info.GetAttributes());
+    }
+

     m_xpos = 0;
     m_ypos = 0;
     m_width = info.m_width;
     m_xpos = 0;
     m_ypos = 0;
     m_width = info.m_width;


@@ -91,11 +100,6 @@ void wxListItemData::SetSize( int width, int height )
     if (height != -1) m_height = height;
 }
 
     if (height != -1) m_height = height;
 }
 

-void wxListItemData::SetColour( wxColour *col )
-{
-    m_colour = col;
-}
-

 bool wxListItemData::HasImage() const
 {
     return (m_image >= 0);
 bool wxListItemData::HasImage() const
 {
     return (m_image >= 0);


@@ -141,17 +145,21 @@ int wxListItemData::GetImage() const
     return m_image;
 }
 
     return m_image;
 }
 

-void wxListItemData::GetItem( wxListItem &info )
+void wxListItemData::GetItem( wxListItem &info ) const

 {
     info.m_text = m_text;
     info.m_image = m_image;
     info.m_data = m_data;
 {
     info.m_text = m_text;
     info.m_image = m_image;
     info.m_data = m_data;

-    info.m_colour = m_colour;
-}

 
 

-wxColour *wxListItemData::GetColour()
-{
-    return m_colour;
+    if ( m_attr )
+    {
+        if ( m_attr->HasTextColour() )
+            info.SetTextColour(m_attr->GetTextColour());
+        if ( m_attr->HasBackgroundColour() )
+            info.SetBackgroundColour(m_attr->GetBackgroundColour());
+        if ( m_attr->HasFont() )
+            info.SetFont(m_attr->GetFont());
+    }

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


@@ -286,8 +294,7 @@ void wxListLineData::CalculateSize( wxDC *dc, int spacing )
             if (node)
             {
                 wxListItemData *item = (wxListItemData*)node->Data();
             if (node)
             {
                 wxListItemData *item = (wxListItemData*)node->Data();

-                wxString s;
-                item->GetText( s );
+                wxString s = item->GetText();

                 long lw,lh;
                 dc->GetTextExtent( s, &lw, &lh );
                 if (lw > m_spacing) m_bound_all.width = lw;
                 long lw,lh;
                 dc->GetTextExtent( s, &lw, &lh );
                 if (lw > m_spacing) m_bound_all.width = lw;


@@ -300,8 +307,7 @@ void wxListLineData::CalculateSize( wxDC *dc, int spacing )
             if (node)
             {
                 wxListItemData *item = (wxListItemData*)node->Data();
             if (node)
             {
                 wxListItemData *item = (wxListItemData*)node->Data();

-                wxString s;
-                item->GetText( s );
+                wxString s = item->GetText();

                 long lw,lh;
                 dc->GetTextExtent( s, &lw, &lh );
                 m_bound_all.width = lw;
                 long lw,lh;
                 dc->GetTextExtent( s, &lw, &lh );
                 m_bound_all.width = lw;


@@ -577,6 +583,34 @@ int wxListLineData::GetImage( int index )
     return -1;
 }
 
     return -1;
 }
 

+void wxListLineData::SetAttributes(wxDC *dc,
+                                   const wxListItemAttr *attr,
+                                   const wxColour& colText,
+                                   const wxFont& font,
+                                   bool hilight)
+{
+    // don't use foregroud colour for drawing highlighted items - this might
+    // make them completely invisible (and there is no way to do bit
+    // arithmetics on wxColour, unfortunately)
+    if ( !hilight && attr && attr->HasTextColour() )
+    {
+        dc->SetTextForeground(attr->GetTextColour());
+    }
+    else
+    {
+        dc->SetTextForeground(colText);
+    }
+
+    if ( attr && attr->HasFont() )
+    {
+        dc->SetFont(attr->GetFont());
+    }
+    else
+    {
+        dc->SetFont(font);
+    }
+}
+

 void wxListLineData::DoDraw( wxDC *dc, bool hilight, bool paintBG )
 {
     long dev_x = dc->LogicalToDeviceX( m_bound_all.x-2 );
 void wxListLineData::DoDraw( wxDC *dc, bool hilight, bool paintBG )
 {
     long dev_x = dc->LogicalToDeviceX( m_bound_all.x-2 );


@@ -589,26 +623,51 @@ void wxListLineData::DoDraw( wxDC *dc, bool hilight, bool paintBG )
         return;
     }
 
         return;
     }
 

-    if (paintBG)
+    wxWindow *listctrl = m_owner->GetParent();
+
+    // default foreground colour
+    wxColour colText;
+    if ( hilight )
+    {
+        colText = wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT );
+    }
+    else
+    {
+        colText = listctrl->GetForegroundColour();
+    }
+
+    // default font
+    wxFont font = listctrl->GetFont();
+
+    // VZ: currently we set the colours/fonts only once, but like this (i.e.
+    //     using SetAttributes() inside the loop), it will be trivial to
+    //     customize the subitems (in report mode) too.
+    wxListItemData *item = (wxListItemData*)m_items.First()->Data();
+    wxListItemAttr *attr = item->GetAttributes();
+    SetAttributes(dc, attr, colText, font, hilight);
+
+    bool hasBgCol = attr && attr->HasBackgroundColour();
+    if ( paintBG || hasBgCol )

     {
         if (hilight)
         {
             dc->SetBrush( * m_hilightBrush );
     {
         if (hilight)
         {
             dc->SetBrush( * m_hilightBrush );

-            dc->SetPen( * wxTRANSPARENT_PEN );

         }
         else
         {
         }
         else
         {

-            dc->SetBrush( * wxWHITE_BRUSH );
-            dc->SetPen( * wxTRANSPARENT_PEN );
+            if ( hasBgCol )
+                dc->SetBrush(wxBrush(attr->GetBackgroundColour(), wxSOLID));
+            else
+                dc->SetBrush( * wxWHITE_BRUSH );

         }
         }

+
+        dc->SetPen( * wxTRANSPARENT_PEN );

         dc->DrawRectangle( m_bound_hilight.x, m_bound_hilight.y,
                            m_bound_hilight.width, m_bound_hilight.height );
     }
 
         dc->DrawRectangle( m_bound_hilight.x, m_bound_hilight.y,
                            m_bound_hilight.width, m_bound_hilight.height );
     }
 

-    dc->SetBackgroundMode(wxTRANSPARENT);

     if (m_mode == wxLC_REPORT)
     {
     if (m_mode == wxLC_REPORT)
     {

-        wxString s;

         wxNode *node = m_items.First();
         while (node)
         {
         wxNode *node = m_items.First();
         while (node)
         {


@@ -624,12 +683,7 @@ void wxListLineData::DoDraw( wxDC *dc, bool hilight, bool paintBG )
             }
             if (item->HasText())
             {
             }
             if (item->HasText())
             {

-                item->GetText( s );
-                if (hilight)
-                    dc->SetTextForeground( wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT ) );
-                else
-                    dc->SetTextForeground( *item->GetColour() );
-                dc->DrawText( s, x, item->GetY() );
+                dc->DrawText( item->GetText(), x, item->GetY() );

             }
             dc->DestroyClippingRegion();
             node = node->Next();
             }
             dc->DestroyClippingRegion();
             node = node->Next();


@@ -647,13 +701,7 @@ void wxListLineData::DoDraw( wxDC *dc, bool hilight, bool paintBG )
             }
             if (item->HasText())
             {
             }
             if (item->HasText())
             {

-                wxString s;
-                item->GetText( s );
-                if (hilight)
-                    dc->SetTextForeground( wxSystemSettings::GetSystemColour( wxSYS_COLOUR_HIGHLIGHTTEXT ) );
-                else
-                    dc->SetTextForeground( * item->GetColour() );
-                dc->DrawText( s, m_bound_label.x, m_bound_label.y );
+                dc->DrawText( item->GetText(), m_bound_label.x, m_bound_label.y );

             }
         }
     }
             }
         }
     }


@@ -662,11 +710,11 @@ void wxListLineData::DoDraw( wxDC *dc, bool hilight, bool paintBG )
 void wxListLineData::Hilight( bool on )
 {
     if (on == m_hilighted) return;
 void wxListLineData::Hilight( bool on )
 {
     if (on == m_hilighted) return;

+    m_hilighted = on;

     if (on)
         m_owner->SelectLine( this );
     else
         m_owner->DeselectLine( this );
     if (on)
         m_owner->SelectLine( this );
     else
         m_owner->DeselectLine( this );

-    m_hilighted = on;

 }
 
 void wxListLineData::ReverseHilight( void )
 }
 
 void wxListLineData::ReverseHilight( void )


@@ -809,7 +857,9 @@ void wxListHeaderWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
 
     dc.SetBackgroundMode(wxTRANSPARENT);
     dc.SetTextForeground( *wxBLACK );
 
     dc.SetBackgroundMode(wxTRANSPARENT);
     dc.SetTextForeground( *wxBLACK );

-    if (m_foregroundColour.Ok()) dc.SetTextForeground( m_foregroundColour );
+
+    // do *not* use the listctrl colour for headers - one day we will have a
+    // function to set it separately

 
     x = 1;
     y = 1;
 
     x = 1;
     y = 1;


@@ -821,9 +871,10 @@ void wxListHeaderWindow::OnPaint( wxPaintEvent &WXUNUSED(event) )
         int cw = item.m_width-2;
 #if wxUSE_GENERIC_LIST_EXTENSIONS
         if ((i+1 == numColumns) || ( dc.LogicalToDeviceX(x+item.m_width) > w-5))
         int cw = item.m_width-2;
 #if wxUSE_GENERIC_LIST_EXTENSIONS
         if ((i+1 == numColumns) || ( dc.LogicalToDeviceX(x+item.m_width) > w-5))

-                cw = dc.DeviceToLogicalX(w)-x-1;
+            cw = dc.DeviceToLogicalX(w)-x-1;

 #else
 #else

-        if ((i+1 == numColumns) || (x+item.m_width > w-5)) cw = w-x-1;
+        if ((i+1 == numColumns) || (x+item.m_width > w-5))
+            cw = w-x-1;

 #endif
         dc.SetPen( *wxWHITE_PEN );
 
 #endif
         dc.SetPen( *wxWHITE_PEN );
 


@@ -981,11 +1032,7 @@ wxListTextCtrl::wxListTextCtrl( wxWindow *parent, const wxWindowID id,
     bool *accept, wxString *res, wxListMainWindow *owner,
     const wxString &value, const wxPoint &pos, const wxSize &size,
 #if wxUSE_VALIDATORS
     bool *accept, wxString *res, wxListMainWindow *owner,
     const wxString &value, const wxPoint &pos, const wxSize &size,
 #if wxUSE_VALIDATORS

-#  if defined(__VISAGECPP__)
-    int style, const wxValidator* validator, const wxString &name ) :
-#  else

     int style, const wxValidator& validator, const wxString &name ) :
     int style, const wxValidator& validator, const wxString &name ) :

-#  endif

 #endif
   wxTextCtrl( parent, id, value, pos, size, style, validator, name )
 {
 #endif
   wxTextCtrl( parent, id, value, pos, size, style, validator, name )
 {


@@ -1212,6 +1259,7 @@ void wxListMainWindow::SendNotify( wxListLineData *line, wxEventType command )
     le.m_itemIndex = GetIndexOfLine( line );
     line->GetItem( 0, le.m_item );
     GetParent()->GetEventHandler()->ProcessEvent( le );
     le.m_itemIndex = GetIndexOfLine( line );
     line->GetItem( 0, le.m_item );
     GetParent()->GetEventHandler()->ProcessEvent( le );

+//    GetParent()->GetEventHandler()->AddPendingEvent( le );

 }
 
 void wxListMainWindow::FocusLine( wxListLineData *WXUNUSED(line) )
 }
 
 void wxListMainWindow::FocusLine( wxListLineData *WXUNUSED(line) )


@@ -1302,7 +1350,7 @@ void wxListMainWindow::OnRenameAccept()
     info.m_mask = wxLIST_MASK_TEXT;
     info.m_itemId = le.m_itemIndex;
     info.m_text = m_renameRes;
     info.m_mask = wxLIST_MASK_TEXT;
     info.m_itemId = le.m_itemIndex;
     info.m_text = m_renameRes;

-    info.m_colour = le.m_item.m_colour;
+    info.SetTextColour(le.m_item.GetTextColour());

     SetItem( info );
 }
 
     SetItem( info );
 }
 


@@ -2528,7 +2576,31 @@ wxListItem::wxListItem()
     m_data = 0;
     m_format = wxLIST_FORMAT_CENTRE;
     m_width = 0;
     m_data = 0;
     m_format = wxLIST_FORMAT_CENTRE;
     m_width = 0;

-    m_colour = wxBLACK;
+
+    m_attr = NULL;
+}
+
+void wxListItem::Clear()
+{
+    m_mask = 0;
+    m_itemId = 0;
+    m_col = 0;
+    m_state = 0;
+    m_stateMask = 0;
+    m_image = 0;
+    m_data = 0;
+    m_format = wxLIST_FORMAT_CENTRE;
+    m_width = 0;
+    m_text = wxEmptyString;
+
+    if (m_attr) delete m_attr;
+    m_attr = NULL;
+}
+
+void wxListItem::ClearAttributes()
+{
+    if (m_attr) delete m_attr;
+    m_attr = NULL;

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


@@ -2549,6 +2621,35 @@ wxListEvent::wxListEvent( wxEventType commandType, int id ):
     m_pointDrag.y = 0;
 }
 
     m_pointDrag.y = 0;
 }
 

+void wxListEvent::CopyObject(wxObject& object_dest) const
+{
+    wxListEvent *obj = (wxListEvent *)&object_dest;
+
+    wxNotifyEvent::CopyObject(object_dest);
+
+    obj->m_code = m_code;
+    obj->m_itemIndex = m_itemIndex;
+    obj->m_oldItemIndex = m_oldItemIndex;
+    obj->m_col = m_col;
+    obj->m_cancelled = m_cancelled;
+    obj->m_pointDrag = m_pointDrag;
+    obj->m_item.m_mask = m_item.m_mask;
+    obj->m_item.m_itemId = m_item.m_itemId;
+    obj->m_item.m_col = m_item.m_col;
+    obj->m_item.m_state = m_item.m_state;
+    obj->m_item.m_stateMask = m_item.m_stateMask;
+    obj->m_item.m_text = m_item.m_text;
+    obj->m_item.m_image = m_item.m_image;
+    obj->m_item.m_data = m_item.m_data;
+    obj->m_item.m_format = m_item.m_format;
+    obj->m_item.m_width = m_item.m_width;
+
+    if ( m_item.HasAttributes() )
+    {
+        obj->m_item.SetTextColour(m_item.GetTextColour());
+    }
+}
+

 // -------------------------------------------------------------------------------------
 // wxListCtrl
 // -------------------------------------------------------------------------------------
 // -------------------------------------------------------------------------------------
 // wxListCtrl
 // -------------------------------------------------------------------------------------


@@ -2576,11 +2677,7 @@ wxListCtrl::~wxListCtrl()
 bool wxListCtrl::Create( wxWindow *parent, wxWindowID id,
       const wxPoint &pos, const wxSize &size,
 #if wxUSE_VALIDATORS
 bool wxListCtrl::Create( wxWindow *parent, wxWindowID id,
       const wxPoint &pos, const wxSize &size,
 #if wxUSE_VALIDATORS

-#  if defined(__VISAGECPP__)
-      long style, const wxValidator *validator,
-#  else

       long style, const wxValidator &validator,
       long style, const wxValidator &validator,

-#  endif

 #endif
       const wxString &name )
 {
 #endif
       const wxString &name )
 {


@@ -2592,12 +2689,20 @@ bool wxListCtrl::Create( wxWindow *parent, wxWindowID id,
 
     long s = style;
 
 
     long s = style;
 

-    if ((s & wxLC_REPORT == 0) &&
+#ifdef __VMS__
+#pragma message disable codcauunr
+   // VMS reports on this part the warning:
+   // statement either is unreachable or causes unreachable code
+#endif
+   if ((s & wxLC_REPORT == 0) &&

         (s & wxLC_LIST == 0) &&
         (s & wxLC_ICON == 0))
     {
         s = s | wxLC_LIST;
     }
         (s & wxLC_LIST == 0) &&
         (s & wxLC_ICON == 0))
     {
         s = s | wxLC_LIST;
     }

+#ifdef __VMS__
+#pragma message enable codcauunr
+#endif

 
     bool ret = wxControl::Create( parent, id, pos, size, s, name );
 
 
     bool ret = wxControl::Create( parent, id, pos, size, s, name );
 


@@ -2847,15 +2952,15 @@ int wxListCtrl::GetSelectedItemCount() const
     return m_mainWin->GetSelectedItemCount();
 }
 
     return m_mainWin->GetSelectedItemCount();
 }
 

-/*

 wxColour wxListCtrl::GetTextColour() const
 {
 wxColour wxListCtrl::GetTextColour() const
 {

+    return GetForegroundColour();

 }
 
 }
 

-void wxListCtrl::SetTextColour(const wxColour& WXUNUSED(col))
+void wxListCtrl::SetTextColour(const wxColour& col)

 {
 {

+    SetForegroundColour(col);

 }
 }

-*/

 
 long wxListCtrl::GetTopItem() const
 {
 
 long wxListCtrl::GetTopItem() const
 {