GItemList.hh

Go to the documentation of this file.

//======================================================================
/*! \file GItemList.hh
 *
 *  Include file for class GItemList.
 */
//======================================================================

#ifndef G_ITEM_LIST_HH
#define G_ITEM_LIST_HH


#include "GItem.hh"
#include "GNamedListT.hh"

///! Iterator type definition for list elements
typedef GListIterT<GItem> GItemListIter;

//======================================================================
/*! \class GItemList
 *
 *  This class defines a list of GItem objects.
 *
 *  It should be considered as a list of pointers on objects of any
 *  type, including base types.
 */
class GItemList : protected GNamedListT<GItem>
{
//----------------------------------------------------------------------
  /*! \object_doc */
  GObject(GItemList);
//----------------------------------------------------------------------

  using GNamedListT<GItem>::Goto;
  using GNamedListT<GItem>::FindName;
  using GNamedListT<GItem>::Begin;
  using GNamedListT<GItem>::End;
  using GNamedListT<GItem>::Null;
  using GNamedListT<GItem>::First;
  using GNamedListT<GItem>::Last;
  using GNamedListT<GItem>::Next;
  using GNamedListT<GItem>::Previous;
  using GNamedListT<GItem>::Current;
  using GNamedListT<GItem>::Index;
  using GNamedListT<GItem>::GetSize;
  using GNamedListT<GItem>::Move;
  using GNamedListT<GItem>::MoveUp;
  using GNamedListT<GItem>::MoveDown;
  using GNamedListT<GItem>::MoveTop;
  using GNamedListT<GItem>::MoveBottom;
  using GNamedListT<GItem>::Sort;
  using GNamedListT<GItem>::ReverseSort;
  using GNamedListT<GItem>::IsReverseSorted;
  using GNamedListT<GItem>::Take;
  using GNamedListT<GItem>::Remove;
  using GNamedListT<GItem>::Empty;

  /// Local iterator definition for collection elements
  typedef GListIterT<GItem>   iterator;

  protected:

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    GItemList ( const u_int fl = 0 );
    GItemList ( const GItemList &original );

    virtual ~GItemList ( );

    GItemList & operator = ( const GItemList &original );

  //------------------------------------------------------------
  // Overloaded functions due to protected inheritance
  //    not included with "using" so that all Remove functions are
  //    not accessible
    inline virtual bool Remove ( );

  //------------------------------------------------------------
    virtual GItem  * Select    ( const u_int n, const bool b = true );
    virtual void     SelectAll ( const bool b = true );

    virtual GItem  * AddItem ( const GItem & item );
    virtual GItem  * AddItem ( GItem * item );
    virtual GItem  * AddItem ( const string &s, void *ptr = NULL );

    virtual int      GetSelectedNumber ( ) const;
};

//----------------------------------------------------------------------
//  Inline functions
#include "icc/GItemList.icc"

//======================================================================
#endif