RGBaseRequester.hh

Go to the documentation of this file.

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

#ifndef RG_BASE_REQUESTER_HH
#define RG_BASE_REQUESTER_HH

#include <iostream>
#include <fstream>
#include <iomanip>
#include <string>

using namespace std ;

#include <TGFrame.h>
#include <TGLabel.h>
#include <TGButton.h>

#include "RBaseFunctions.hh"
#include "RDico.hh"

///! Base requesters otptions.
enum RGRequestOptions
{
  // format de la zone de widgets additionnels
  rgReqVerticalFrame   = 0x00000000,      // vertical layout (default)
  rgReqHorizontalFrame = 0x00000001,      // horizontal vertical 
  rgReqFrameType       = 0x00000001,      // layout options bits
  rgReqNoExpandX       = 0x00000002,      // X expansion option
  rgReqNoExpandY       = 0x00000004,      // Y expansion option

  // position des boutons de requête
  rgReqButtonsBottom      = 0x00000000,     // buttons under the request (default)
  rgReqButtonsRight       = 0x00000040,     // buttons on the right side (centered)
  rgReqButtonsRightTop    = 0x00000140,     // buttons on the right side (up)
  rgReqButtonsRightBottom = 0x00000240,     // buttons on the right side (down)
  rgReqButtonsLeft        = 0x000000C0,     // buttons on the left side (centered)
  rgReqButtonsLeftTop     = 0x000001C0,     // buttons on the left side (up)
  rgReqButtonsLeftBottom  = 0x000002C0,     // buttons on the left side (down)
  rgReqButtonsSideTop     = 0x00000100,     // side buttons up
  rgReqButtonsSideBottom  = 0x00000200,     // side buttons down
  rgReqButtonsSide        = 0x00000300,     // side buttons options
  rgReqButtonsPosition    = 0x000003C0,     // buttons position options bits

  // autres options
  rgReqNoWait             = 0x00001000      // do not wait for request to complete
};

//======================================================================
/*! class RGBaseRequester
 *
 *  Base class to define requests that expect a result from button click.
 *
 *  When the request is executed, the result is stored in \b result variable.
 *  The values correspond to button numbers, starting at 1, except the
 *  last one that is 0, like the window close button.
 *
 *  Buttons are defined in a single character string, each button text
 *  separated from others with '|' character.
 *  When a button is selected, the request is closed, except if the button
 *  text ends with '*', or if a slot is called that calls the CancelClose()
 *  function.
 *
 *  Base requester options:
 *  - format for addtionnal widgets frame
 *    - \b rgReqVerticalFrame  
 *    - \b rgReqHorizontalFrame
 *    - \b rgReqFrameType      
 *    - \b rgReqNoExpandX      
 *    - \b rgReqNoExpandY      
 *
 *  - position of request buttons
 *    - \b rgReqButtonsBottom     
 *    - \b rgReqButtonsRight      
 *    - \b rgReqButtonsRightTop   
 *    - \b rgReqButtonsRightBottom
 *    - \b rgReqButtonsLeft       
 *    - \b rgReqButtonsLeftTop    
 *    - \b rgReqButtonsLeftBottom 
 *    - \b rgReqButtonsSideTop    
 *    - \b rgReqButtonsSideBottom 
 *    - \b rgReqButtonsSide       
 *    - \b rgReqButtonsPosition   
 *
 *  - other options
 *    - \b rgReqNoWait
 */
class RGBaseRequester : public TGTransientFrame
{
  //------------------------------------------------------------
  /*! \object_doc{RGBaseRequester} */
  GObject(RGBaseRequester);
  //------------------------------------------------------------

  protected:

    static  UInt_t      max_width;    ///< Maximum request width
    static  UInt_t      max_height;   ///< Maximum request height

#ifndef __MAKECINT__
    int * result_adr;                 ///< Request resul pointer
#endif

    string              req_title;          ///< Request title
#ifndef __MAKECINT__
    const char        * req_buttons;        ///< Buttons texts
#endif
    UInt_t              options;            ///< Request options

    ULong_t             req_button_layout;  ///< Buttons layout

    TGCompositeFrame  * w_widget_frame;     ///< Frame for widgets
    TGCompositeFrame  * w_buttons_frame;    ///< Frame for buttons

    TList               buttons_list;       ///< List of created buttons

    Bool_t              cancel_close;       ///< Check for close cancellation


  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    // Constructor with return value
    RGBaseRequester ( const TGWindow * parent,
                      const TGWindow * main,
                      int            & result,
                      const char     * title,
                      const char     * buttons    = rDico.brq_ok_cancel.c_str(),
                      const ULong_t    opts       = 0,
                      const bool       auto_start = true );

    // Constructor without return value (for derived classes)
    RGBaseRequester ( const TGWindow * parent,
                      const TGWindow * main,
                      const char     * title,
                      const char     * buttons    = rDico.brq_ok_cancel.c_str(),
                      const ULong_t    opts       = 0,
                      const bool       auto_start = false );

  protected:
    RGBaseRequester ( const RGBaseRequester & req );

  public:
    virtual ~RGBaseRequester();

  //------------------------------------------------------------
  protected:
    // setting base widgets
    virtual void   Construct ( );

  public:
    // request mapping
    virtual void  MapRequester ( );

    // request execution
    virtual void  Request ( );

    // access to requester widgets pointers
    virtual TGCompositeFrame  * GetFrame  ( ) const;
    virtual TGHorizontalFrame * GetHFrame ( ) const;
    virtual TGVerticalFrame   * GetVFrame ( ) const;

    // adding widgets
    virtual void    AddFrame (TGFrame *f, TGLayoutHints *l = 0);

    virtual void    CloseFromButton ( );
    virtual void    CancelClose ( const Bool_t b = kTRUE );

    // Signals
    virtual void  ReqButtonClicked ( Int_t n );   // *SIGNAL*

    // Slots
    virtual void        ProcessedEvent ( Event_t * event );

    // buttons slots
    virtual void  Button  ( Int_t n );
    virtual void  Quit    ( );

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

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

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