RGListRequester.hh

Go to the documentation of this file.

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

#ifndef RG_LIST_REQUESTER_HH
#define RG_LIST_REQUESTER_HH

#include "RGBaseRequester.hh"
#include "RGItemListBox.hh"
#include "RDico.hh"


/*! New options for RGListRequester.*/
enum RGListRequestOptions
{
  rgReqNoDoubleClick = 0x00010000  // inhibit double-click
};

//======================================================================
/*! class RGListRequester
 *
 *  Request for a selection in a list of elements, presented with a
 *  text name.
 *
 *  Depending on the constructor, the request returns (\b N beeing the
 *  number of entries):
 *  - the close button and an array of \b N logic values indicating whether
 *    elements are selected or not (multiple selection);
 *  - the close button and a result between 0 and \b N-1 of the selected
 *    element (single selection), or -1 if no element is selected;
 *  - a result between 0 and \b N-1 of the selected element (single selection),
 *    or -1 if no element is selected.
 *
 *  According to the case, the returned value in case of cancellation may
 *  be modified.
 *
 *  Specific options:
 *    - \b   rgReqNoDoubleClick     inhibits the single selection double-click
 *
 *  \note
 *    a double-click causes the first button click.
 */
class RGListRequester : public RGBaseRequester
{
  //------------------------------------------------------------
  /*! \object_doc{RGListRequester} */
  GObject(RGListRequester);
  //------------------------------------------------------------

  protected:

#ifndef __MAKECINT__
    int   * select_adr;           ///<  Pointer on selection result (single selection)
    bool  * select_table;         ///<  Array of selection values (multiple selection)

    int     selected;             ///<  Selected element (last)
    bool    select_multi;         ///<  Multiple selection flag

    const string *items_list;     ///<  Array of list elements names
    int           items_number;   ///<  Number of elements
    int           max_visible;    ///<  Display: number of visible elements

    UInt_t        list_width;     ///< List width
    UInt_t        list_height;    ///< List height
#endif

  // widgets
    RGItemListBox   * w_select_list;  ///<  Selection list widget


  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    // Button value return and selection array (multiple)
    RGListRequester ( const TGWindow * parent,
                      const TGWindow * main,
                      const string     items[],
                      const u_int      items_num,
                      int            & result,
                      bool          *& table,
                      const char     * title,
                      const char     * buttons    = rDico.brq_ok_cancel.c_str(),
                      const ULong_t    opts       = 0,
                      const int      & display    = 0,
                      const bool       auto_start = true);

    // Button value return and selection value (single)
    RGListRequester ( const TGWindow * parent,
                      const TGWindow * main,
                      const string     items[],
                      const u_int      items_num,
                      int            & result,
                      int            & selection,
                      const char     * title,
                      const char     * buttons    = rDico.brq_ok_cancel.c_str(),
                      const ULong_t    opts       = 0,
                      const int      & display    = 0,
                      const bool       auto_start = true);

    // Selection value (single)
    RGListRequester ( const TGWindow * parent,
                      const TGWindow * main,
                      const string     items[],
                      const u_int      items_num,
                      int            & selection,
                      const char     * title,
                      const char     * buttons    = rDico.brq_ok_cancel.c_str(),
                      const ULong_t    opts       = 0,
                      const int      & display    = 0,
                      const bool       auto_start = true);

    // Constructor for derived classes: no return
    RGListRequester ( const TGWindow * parent,
                      const TGWindow * main,
                      const string   * items,
                      const u_int      items_num,
                      const char     * title,
                      const char     * buttons = rDico.brq_ok_cancel.c_str(),
                      const ULong_t    opts    = 0,
                      const int      & display = 0,
                      const bool       multi   = false );

  private:
    RGListRequester ( const RGListRequester & req );

  public:
    virtual ~RGListRequester();

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

  // Execution
    //virtual void  Request ( );

    virtual void  ItemSelected  ( Int_t n );
    virtual void  DoubleClicked ( Int_t n );

  //------------------------------------------------------------
  // Slots
    virtual void  ProcessButton ( Int_t n );

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


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