RGItem.hh

Go to the documentation of this file.

//======================================================================
/*! \file RGItem.hh
 *
 *  Include file defining type names related to GItem and RGItem.
 */
//======================================================================

#ifndef RG_ITEM_HH
#define RG_ITEM_HH

#include "GItem.hh"
#include "GItemList.hh"

#include <TGPicture.h>

//======================================================================
/*! \class RGItem
 *
 *  This class is derived from GItem, for items that require addidional
 *  display information (icon,...)
 *
 *  An additional information pointer is provided, for exemple to store
 *  the pointer to ROOT GUI objects referring to this item
 *  (this is the case in RGItemTreeList widget).
 */
class RGItem : public GItem
{
  //------------------------------------------------------------
  /*! \object_doc{RGItem} */
  GObject(RGItem);
  //------------------------------------------------------------

  protected:
    const TGPicture * icon_ptr;   ///< Pointer to the ROOT icon picture

    void            * info_ptr;   ///< Pointer for additional information

  //------------------------------------------------------------
  /** @name Constructors, affectation, destructor */
  //@{
  public:

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

    virtual ~RGItem ( );

    RGItem & operator = ( const RGItem &original );
  //@}

  //------------------------------------------------------------
  /** @name Specific functions */
  //@{
    void              SetIcon ( const TGPicture * icon );       // inline
    void              SetIcon ( const string    & icon_name );  // inline
    const TGPicture * GetIcon ( ) const;                        // inline

    void    SetInfoPtr ( void * ptr );    // inline
    void  * GetInfoPtr ( ) const;         // inline
  //@}

  //------------------------------------------------------------
  /** @name Overloaded functions */
  //@{
    // Comparison operators
    bool    operator == ( const RGItem &item );

  //@}

};

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

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