RGTreeRequester.hh

Go to the documentation of this file.

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

#ifndef RG_TREE_REQUESTER_HH
#define RG_TREE_REQUESTER_HH

#include "RGBaseRequester.hh"
#include "RGItemTreeSelector.hh"
#include "RDico.hh"


/*! New options for RGTreeRequester.*/
enum RGTreeRequestOptions
{
  rgReqNoFolder = 0x00020000  // do not allow directory selection in single selection mode
};

//======================================================================
/*! class RGTreeRequester
 *
 *  Request for a selection (single or multiple) in a tree of elements,
 *  given by a tree structure of GItems.
 *
 *  Note that the tree structure is not modified by the requester.
 *  Only the selection flag of tree items may be changed.
 *
 *  Depending on the constructor, the request returns a single or a
 *  multiple selection, and the button result.
 *
 *  \par Tree structure
 *
 *  The tree structure is described in the RGItemTreeSelector widget
 *  documentation.
 *
 *  \par Multiple selection
 *
 *  For the multiple selection, only items (leaves= can be selected.
 *  The folders do not belong to the selection.
 *
 *  \par Single selection
 *
 *  The single selection allows to select either an item (leaf) or a folder
 *  (branch), except if the rgReqNoFolder option is defined (at requester
 *  creation).
 */
class RGTreeRequester : public RGBaseRequester
{
  //------------------------------------------------------------
  /*! \object_doc{RGTreeRequester} */
  GObject(RGTreeRequester);
  //------------------------------------------------------------

  protected:
    static  UInt_t    tree_min_width;       ///< Minimum tree width
    static  UInt_t    tree_min_height;      ///< Minimum tree height

    bool              select_multi;         ///< Multiple selection flag

    GItemTreeBranch * items_tree;       ///< Tree structure of GItems (or RGItems)
    GItemList       * selected_list;    ///< Pointer to the list of selected items (multiple selection)
    GItemTreeNode  ** selected_item;    ///< Pointer to the selected item node (single selection)

  // widgets
    RGItemTreeSelector  * w_select_tree;    ///<  Selection tree widget


  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    // Button value return and list of selected items (multiple)
    RGTreeRequester ( const TGWindow  * parent,       // parent window
                      const TGWindow  * main,         // main window
                      GItemTreeBranch * tree_root,    // items tree
                      int             & result,       // requester result (button)
                      GItemList       & sel_list,     // resulting list of selected items
                      const char      * title,
                      const char      * buttons    = rDico.brq_ok_cancel.c_str(),
                      ULong_t           opts       = 0,
                      bool              auto_start = true );

    // Button value return and selected item (single)
    RGTreeRequester ( const TGWindow  * parent,       // parent window
                      const TGWindow  * main,         // main window
                      GItemTreeBranch * tree_root,    // items tree
                      int             & result,       // requester result (button)
                      GItemTreeNode  *& sel_item,     // pointer to resulting selected (single) item node
                      const char      * title,
                      const char      * buttons    = rDico.brq_ok_cancel.c_str(),
                      ULong_t           opts       = 0,
                      bool              auto_start = true );

    // Selected item return (single)
    RGTreeRequester ( const TGWindow  * parent,       // parent window
                      const TGWindow  * main,         // main window
                      GItemTreeBranch * tree_root,    // items tree
                      GItemTreeNode  *& sel_item,     // pointer to resulting selected (single) item node
                      const char      * title,
                      const char      * buttons    = rDico.brq_ok_cancel.c_str(),
                      ULong_t           opts       = 0,
                      bool              auto_start = true );

    // Constructor for derived classes: no return
    // It can also be used for multiple selection, with no return value
    // (the result can be found using selection flag of the items)
    RGTreeRequester ( const TGWindow  * parent,       // parent window
                      const TGWindow  * main,         // main window
                      GItemTreeBranch * tree_root,    // items tree
                      const char      * title,
                      const char      * buttons    = rDico.brq_ok_cancel.c_str(),
                      ULong_t           opts       = 0,
                      bool              multi      = false,
                      bool              auto_start = false );

  private:
    RGTreeRequester ( const RGTreeRequester & req );

  public:
    virtual ~RGTreeRequester();

  //------------------------------------------------------------
  // Construction
    virtual void  Construct    ( );
    virtual void  MapRequester ( );

    RGItemTreeSelector * GetItemTreeSelector ( );   // inline

  //------------------------------------------------------------
  // Slots
    virtual void  SingleSelected  ( ULong64_t leaf_ptr );
    virtual void  ProcessButton   ( Int_t n );

  //------------------------------------------------------------
  /*! For ROOT dictionary.*/
    ClassDef(RGTreeRequester,0);
};


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

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