GItem.hh

Go to the documentation of this file.

//======================================================================
/*! \file GItem.hh
 *
 *  Include file for classes GItem and GSubItem.
 */
//======================================================================

#ifndef G_ITEM_HH
#define G_ITEM_HH

#include "GNamed.hh"

//======================================================================
/*! \class GItem
 *
 *  This class defines base elements for collections of pointer on objects
 *  of any type.
 *
 *  This class is used to generate objects lists for graphical interfaces.
 *
 *  A name is associated to each element (pointer), and an identification
 *  number.
 */
class GItem : public GNamed
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GItem);
  //------------------------------------------------------------

  protected:
    bool      selected;     ///< Indicates if the element is selected
    int       id;           ///< Identification number (for ROOT widgets)
//#ifndef __MAKECINT__
    void    * user_data;    ///< Pointer on user data
//#endif
    string    data_info;    ///< More detailed information (if required)

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:

    GItem ( const string &s, void *ptr = NULL, const int n = 0 );
    GItem ( const GItem &original );

    virtual ~GItem ( );

    GItem & operator = ( const GItem &original );

  //------------------------------------------------------------
  // Comparison operators
    bool  operator == ( const GItem &item );

  //------------------------------------------------------------
    int     GetId       ( ) const;
    void    SetId       ( const int n );
    void *  GetUserData ( ) const;
    void    SetUserData ( void * ptr );

    virtual string  GetInfo ( ) const;                // inline
    virtual void    SetInfo ( const string & info );  // inline

  //------------------------------------------------------------
    void    Select     ( const bool b = true );
    bool    IsSelected ( ) const;

};


//======================================================================
/*! \class GSubItem
 *
 *  This class is derived from GItem, for elements of sub-lists build
 *  from a main list.
 *
 *  The element in the main list is refered to with the \b parent pointer.
 *
 *  This class is used for example by GItemSelectionBox widget.
 */
class GSubItem : public GItem
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GSubItem);
  //------------------------------------------------------------

  protected:
    GItem   * parent;   ///< Pointer to the element in main list

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:

    GSubItem ( const string &s, void *ptr = NULL, const int n = 0, GItem *p = NULL );
    GSubItem ( const GSubItem &original );
    GSubItem ( GItem *p, const bool udat = true );

    virtual ~GSubItem ( );

    GSubItem & operator = ( const GSubItem &original );

  //------------------------------------------------------------
  // Comparison operators
    bool    operator == ( const GSubItem &item );

  //------------------------------------------------------------
    GItem * GetParentItem ( ) const;
    void    SetParentItem ( GItem * par );

};

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

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