qwt_polar_itemdict.cpp

/* -*- mode: C++ ; c-file-style: "stroustrup" -*- *****************************
 * QwtPolar Widget Library
 * Copyright (C) 2008   Uwe Rathmann
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the Qwt License, Version 1.0
 *****************************************************************************/

#include "qwt_polar_itemdict.h"

class QwtPolarItemDict::PrivateData
{
  public:

#if QT_VERSION < 0x040000
    class ItemList: public QValueList<QwtPolarItem *>
#else
    class ItemList: public QList<QwtPolarItem *>
#endif
    {
      public:
        void insertItem( QwtPolarItem *item )
        {
          if ( item == NULL )
            return;

          // Unfortunately there is no inSort operation
          // for lists in Qt4. The implementation below
          // is slow, but there shouldn't be many plot items.

	  // TODO add binary search

#if QT_VERSION < 0x040000
          QValueListIterator<QwtPolarItem *> it;
#else
          QList<QwtPolarItem *>::Iterator it;
#endif
          for ( it = begin(); it != end(); ++it )
          {
            if ( *it == item )
              return;

            if (( *it )->z() > item->z() )
            {
              insert( it, item );
              return;
            }
          }
          append( item );
        }

        void removeItem( QwtPolarItem *item )
        {
          if ( item == NULL )
            return;

          int i = 0;

#if QT_VERSION < 0x040000
          QValueListIterator<QwtPolarItem *> it;
#else
          QList<QwtPolarItem *>::Iterator it;
#endif
          for ( it = begin(); it != end(); ++it )
          {
            if ( item == *it )
            {
#if QT_VERSION < 0x040000
              remove( it );
#else
              removeAt( i );
#endif
              return;
            }
            i++;
          }
        }
    };

    ItemList itemList;
    bool autoDelete;
};

/*!
   Constructor

   Auto deletion is enabled.
   \sa setAutoDelete, attachItem
*/
QwtPolarItemDict::QwtPolarItemDict()
{
  d_data = new QwtPolarItemDict::PrivateData;
  d_data->autoDelete = true;
}

/*!
   Destructor

   If autoDelete is on, all attached items will be deleted
   \sa setAutoDelete, autoDelete, attachItem
*/
QwtPolarItemDict::~QwtPolarItemDict()
{
  detachItems( QwtPolarItem::Rtti_PolarItem, d_data->autoDelete );
  delete d_data;
}

/*!
   En/Disable Auto deletion

   If Auto deletion is on all attached plot items will be deleted
   in the destructor of QwtPolarItemDict. The default value is on.

   \sa autoDelete, attachItem
*/
void QwtPolarItemDict::setAutoDelete( bool autoDelete )
{
  d_data->autoDelete = autoDelete;
}

/*!
   \return true if auto deletion is enabled
   \sa setAutoDelete, attachItem
*/
bool QwtPolarItemDict::autoDelete() const
{
  return d_data->autoDelete;
}

/*!
   Attach/Detach a plot item

   Attached items will be deleted in the destructor,
   if auto deletion is enabled (default). Manually detached
   items are not deleted.

   \param item Plot item to attach/detach
   \ on If true attach, else detach the item

   \sa setAutoDelete, ~QwtPolarItemDict
*/
void QwtPolarItemDict::attachItem( QwtPolarItem *item, bool on )
{
  if ( on )
    d_data->itemList.insertItem( item );
  else
    d_data->itemList.removeItem( item );
}

/*!
   Detach items from the dictionary

   \param rtti In case of QwtPolarItem::Rtti_PlotItem detach all items
               otherwise only those items of the type rtti.
   \param autoDelete If true, delete all detached items
*/
void QwtPolarItemDict::detachItems( int rtti, bool autoDelete )
{
  PrivateData::ItemList list = d_data->itemList;
  QwtPolarItemIterator it = list.begin();
  while ( it != list.end() )
  {
    QwtPolarItem *item = *it;

    ++it; // increment before removing item from the list

    if ( rtti == QwtPolarItem::Rtti_PolarItem || item->rtti() == rtti )
    {
      item->attach( NULL );
      if ( autoDelete )
        delete item;
    }
  }
}

//! \brief A QwtPolarItemList of all attached plot items.
///
/// Use caution when iterating these lists, as removing/detaching an item will
/// invalidate the iterator. Instead you can place pointers to objects to be
/// removed in a removal list, and traverse that list later.
//! \return List of all attached plot items.

const QwtPolarItemList &QwtPolarItemDict::itemList() const
{
  return d_data->itemList;
}