RGItemSelectionBox.hh

Go to the documentation of this file.

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

#ifndef RG_ITEM_SELECTION_BOX_HH
#define RG_ITEM_SELECTION_BOX_HH

#include "RBaseFunctions.hh"
#include "RGItemListBox.hh"

// ROOT include files
#include <TGFrame.h>
#include <TGListBox.h>
#include <TGLabel.h>
#include <TGButton.h>

///! ItemSelectionBox widget options
enum RGItemSelectionBoxOptions
{
  // position des labels
  rgISBLabelsCenterAligned    = 0x00000000,  // labels centrés (défaut)
  rgISBLabelsLeftAligned      = 0x00000001,  // labels placés à gauche
  rgISBLabelsRightAligned     = 0x00000002,  // labels placés à droite
  rgISBLabelsExternAligned    = 0x00000003,  // labels placés côtés extérieurs
  rgISBLabelsInternAligned    = 0x00000004,  // labels placés côtés intérieurs

  rgISBLabelsAboveList        = 0x00000000,  // labels placés au dessus de la liste (défaut)
  rgISBLabelsBelowList        = 0x00000008,  // labels placés sous la liste

  // position verticale des boutons latéraux (identique pour les 2 listes)
  rgISBSideButtonsCenter      = 0x00000000,   // boutons latéraux placés au milieu verticalement (défaut)
  rgISBSideButtonsUp          = 0x00000010,   // boutons latéraux placés en haut
  rgICBSideButtonsDown        = 0x00000020,   // boutons latéraux placés en bas

  // modes de fonctionnement
  rgISBMultipleSelection      = 0x00000100,   // une entrée peut être sélectionnée plusieurs fois en sortie
  rgISBUniqueItem             = 0x00000200,   // interdit que 2 éléments source soient identiques (nom et pointeur de donnée)
  rgISBUniqueName             = 0x00000600,   // interdit que 2 éléments source aient le même nom (plus restrictif que rgISBUniqueItem)
  rgISBNoCaseSensitive        = 0x00000800,   // la liste n'est pas sensible aux majuscules/minuscules
  rgISBDictSort               = 0x00001000,   // la liste n'est pas sensible aux majuscules/minuscules
  rgISBAlwaysSorted           = 0x00002000,   // la liste est toujours triée  rgISBReverseSort            = 0x00004000,   // le tri normal est descendant
  rgISBAlwaysReverseSorted    = 0x00006000,   // la liste est toujours triée, et l'ordre est descendant

  // boutons de déplacement des éléments dans les listes
  rgISBMoveSrcButtons         = 0x00010000,   // boutons de déplacement des éléments source
  rgISBMoveDestButtons        = 0x00020000    // boutons de déplacement des éléments destination
};


//======================================================================
/*! \class RGItemSelectionBox
 *
 *  This class defines a widget with 2 lists for selection of elements.
 *  One list (on the left) is the source of objects, the other one (on the
 *  right), is the selection.
 *  Each list management is based on a RGItemListBox object.
 *
 *  The class RGItemSelectionBox only defines one list of objects as
 *  an input (the global list), and the elements of this global list
 *  are copied in the source and destination lists of RGItemListBox objects.
 *
 *  The elements of the source and destination lists have the same name
 *  than the elements from the global list, and the user data pointer
 *  is set to the global list GItem (and not to the user object itself).
 *  Thus, elements from the source or destination lists is uniquely
 *  associated to a element in the global list: if an element is removed
 *  in the global list is removed, all elements corresponding in the
 *  source and destination sub-lists are removed also.
 *  But if the global list element was present several times in the
 *  list, these elements are not removed.
 *
 *  The user data for source and destination lists can be modified
 *  compared to the global list, and can be different in source and
 *  destination sub-lists.
 *  This feature allows for example to set specific properties to the
 *  selected objects, and keep track of the information until the end
 *  of use of the selection widget.
 *  This requires to have specific signals when elements from the source
 *  or the destination sub-lists are removed (such signal is not emitted
 *  when the element is moved between source and destination sub-lists).
 *
 *
 *  \image html RGItemSelectionBox.gif
 *
 *  The options are in principle fixed at widget creation.
 *
 *  - options for labels of source and destination lists
 *    - \b rgISBLabelsCenterAligned:    labels centered (default)
 *    - \b rgISBLabelsLeftAligned:      labels left aligned
 *    - \b rgISBLabelsRightAligned:     labels right aligned
 *    - \b rgISBLabelsExternAligned:    labels at external side
 *    - \b rgISBLabelsInternAligned:    labels at internal side
 *    - \b rgISBLabelsAboveList:        labels above lists (default)
 *    - \b rgISBLabelsBelowList:        labels below lists
 *
 *  - options for central and side buttons position
 *    - \b rgISBSideButtonsCenter:      buttons vertically centered (default)
 *    - \b rgISBSideButtonsUp:          buttons aligned top
 *    - \b rgICBSideButtonsDown:        buttons aligned bottom
 *
 *  - options for lists
 *    - \b rgISBMultipleSelection:      same input can be selected several times for output
 *    - \b rgISBUniqueItem:             source elements are unique (name and data pointer)
 *    - \b rgISBUniqueName:             source elements have unique name (more restrictive than rgISBUniqueItem)
 *    - \b rgISBNoCaseSensitive:        not case sensitive
 *    - \b rgISBDictSort:               not case/accent sensitive for sorting
 *    - \b rgISBAlwaysSorted:           list is always sorted
 *    - \b rgISBReverseSort:            invert sorting order
 *    - \b rgISBAlwaysReverseSorted:    list is always sorted in reverse order
 *
 *  - options for source and destination sub-lists
 *    - \b rgISBMoveSrcButtons:         move buttons for source elements
 *    - \b rgISBMoveDestButtons:        move buttons for destination elements
 */
class RGItemSelectionBox : public TGHorizontalFrame
{
  //------------------------------------------------------------
  /*! \object_doc{RGItemSelectionBox} */
  GObject(RGItemSelectionBox);
  //------------------------------------------------------------

  protected:
    UInt_t              list_w_min;           ///< List widget minimum width
    UInt_t              list_h_min;           ///< List widget minimum height

    UInt_t              options;              ///< Widget options

    GItemList           item_list;            ///< Input list of elements (global list)

    RGItemListBox       * src_box;            ///< Source selection box
    RGItemListBox       * dest_box;           ///< Destination selection box

    TGVerticalFrame     * w_center_frame;     ///< Central frame for buttons
    TGTextButton        * w_add_button;       ///< Add to selection button
    TGTextButton        * w_remove_button;    ///< Remove from selection button

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RGItemSelectionBox ( TGWindow    *p,
                         const char  *txt_src  = NULL,
                         const char  *txt_dest = NULL,
                         const UInt_t opts     = 0,
                         const UInt_t w_min    = 80,
                         const UInt_t h_min    = 80 );
    
  protected:
    RGItemSelectionBox ( const RGItemSelectionBox &original );

  public:
    virtual ~RGItemSelectionBox ( );

  //------------------------------------------------------------
  // widgets functions
    virtual void              MapSubwindows      ( );
    virtual RGItemListBox   * GetSrcItemListBox  ( ) const;   // inline
    virtual RGItemListBox   * GetDestItemListBox ( ) const;   // inline
    virtual TGVerticalFrame * GetCenterFrame     ( ) const;   // inline

    virtual TGButton  * AddSrcButton    ( const char *text, const Int_t id, const char *tooltip = NULL );
    virtual TGButton  * AddSrcButton    ( TGButton *but, const Int_t id );
    virtual TGButton  * AddDestButton   ( const char *text, const Int_t id, const char *tooltip = NULL );
    virtual TGButton  * AddDestButton   ( TGButton *but, const Int_t id );
    virtual TGButton  * AddCenterButton ( const char *text, const Int_t id, const char *tooltip = NULL );
    virtual TGButton  * AddCenterButton ( TGButton *but, const Int_t id );

    virtual TGFrame   * AddSrcBottomFrame  ( TGFrame *f, TGLayoutHints *l = NULL );
    virtual TGFrame   * AddDestBottomFrame ( TGFrame *f, TGLayoutHints *l = NULL );

    // Lists functions
    virtual Int_t   AddItem ( const string & s, void *ptr = NULL, const Bool_t update = true);
    virtual Int_t   AddItem ( const GItem  & d, const Bool_t update = true);
    virtual Int_t   AddItem (       GItem  * d, const Bool_t update = true);

    virtual void    RemoveItem ( const Int_t n, const Bool_t update = true );

    virtual GItem     * GetItem     ( Int_t id ) const;
    virtual GSubItem  * GetSrcItem  ( Int_t id ) const;
    virtual GSubItem  * GetDestItem ( Int_t id ) const;

  protected:
    virtual void    RemoveSelectedItem ( const Bool_t update = true );
    virtual void    RemoveSubItems     ( GItem *supp, const Bool_t update = true, const Bool_t sub_signal = true );

  public:
    virtual void    SrcSelectionRemove  ( );
    virtual void    DestSelectionRemove ( );
  protected:
    virtual void    SelectionRemove ( RGItemListBox *ilb );

  public:
    // récupération des listes
    virtual GItemListIter   SrcBegin  ( ) const;    // inline
    virtual GItemListIter   SrcEnd    ( ) const;    // inline
    virtual GItemListIter   DestBegin ( ) const;    // inline
    virtual GItemListIter   DestEnd   ( ) const;    // inline
    virtual GItemListIter   Begin     ( ) const;    // inline
    virtual GItemListIter   End       ( ) const;    // inline
    virtual GItemListIter   Null      ( ) const;    // inline

    virtual Int_t           GetSize     ( ) const;  // inline
    virtual Int_t           GetSrcSize  ( ) const;  // inline
    virtual Int_t           GetDestSize ( ) const;  // inline

    // fonctions à usage interne (elles n'ont pas besoin d'être protégées)
    virtual void    UpdateSelectionBox ( );

    // Slots des widgets internes
    virtual Int_t   ItemToDest    ( const Int_t num, const Bool_t update = false );
    virtual Int_t   SrcItemToDest ( const Int_t num, const Bool_t update = false );

    virtual void    SrcDoubleClicked   ( Int_t n );
    virtual void    DestDoubleClicked  ( Int_t n );

    virtual void    SrcSelectionToDest ( );
    virtual void    DestSelectionToSrc ( );

    //----------------------------------------------------------
    //  SIGNALS
    virtual void  ItemRemoved          ( ULong_t ptr ); // *SIGNAL*
    virtual void  SrcItemRemoved       ( ULong_t ptr ); // *SIGNAL*
    virtual void  DestItemRemoved      ( ULong_t ptr ); // *SIGNAL*
    virtual void  CustomClicked        ( Int_t id );    // *SIGNAL*
    virtual void  SelectionChanged     ( );             // *SIGNAL*
    virtual void  SrcSelectionChanged  ( );             // *SIGNAL*
    virtual void  DestSelectionChanged ( );             // *SIGNAL*


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

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

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

  rgISBReverseSort            = 0x00004000,   // le tri normal est descendant
  rgISBAlwaysReverseSorted    = 0x00006000,   // la liste est toujours triée, et l'ordre est descendant

  // boutons de déplacement des éléments dans les listes
  rgISBMoveSrcButtons         = 0x00010000,   // boutons de déplacement des éléments source
  rgISBMoveDestButtons        = 0x00020000    // boutons de déplacement des éléments destination
};


//======================================================================
/*! \class RGItemSelectionBox
 *
 *  This class defines a widget with 2 lists for selection of elements.
 *  One list (on the left) is the source of objects, the other one (on the
 *  right), is the selection.
 *  Each list management is based on a RGItemListBox object.
 *
 *  The class RGItemSelectionBox only defines one list of objects as
 *  an input (the global list), and the elements of this global list
 *  are copied in the source and destination lists of RGItemListBox objects.
 *
 *  The elements of the source and destination lists have the same name
 *  than the elements from the global list, and the user data pointer
 *  is set to the global list GItem (and not to the user object itself).
 *  Thus, elements from the source or destination lists is uniquely
 *  associated to a element in the global list: if an element is removed
 *  in the global list is removed, all elements corresponding in the
 *  source and destination sub-lists are removed also.
 *  But if the global list element was present several times in the
 *  list, these elements are not removed.
 *
 *  The user data for source and destination lists can be modified
 *  compared to the global list, and can be different in source and
 *  destination sub-lists.
 *  This feature allows for example to set specific properties to the
 *  selected objects, and keep track of the information until the end
 *  of use of the selection widget.
 *  This requires to have specific signals when elements from the source
 *  or the destination sub-lists are removed (such signal is not emitted
 *  when the element is moved between source and destination sub-lists).
 *
 *
 *  \image html RGItemSelectionBox.gif
 *
 *  The options are in principle fixed at widget creation.
 *
 *  - options for labels of source and destination lists
 *    - \b rgISBLabelsCenterAligned:    labels centered (default)
 *    - \b rgISBLabelsLeftAligned:      labels left aligned
 *    - \b rgISBLabelsRightAligned:     labels right aligned
 *    - \b rgISBLabelsExternAligned:    labels at external side
 *    - \b rgISBLabelsInternAligned:    labels at internal side
 *    - \b rgISBLabelsAboveList:        labels above lists (default)
 *    - \b rgISBLabelsBelowList:        labels below lists
 *
 *  - options for central and side buttons position
 *    - \b rgISBSideButtonsCenter:      buttons vertically centered (default)
 *    - \b rgISBSideButtonsUp:          buttons aligned top
 *    - \b rgICBSideButtonsDown:        buttons aligned bottom
 *
 *  - options for lists
 *    - \b rgISBMultipleSelection:      same input can be selected several times for output
 *    - \b rgISBUniqueItem:             source elements are unique (name and data pointer)
 *    - \b rgISBUniqueName:             source elements have unique name (more restrictive than rgISBUniqueItem)
 *    - \b rgISBNoCaseSensitive:        not case sensitive
 *    - \b rgISBDictSort:               not case/accent sensitive for sorting
 *    - \b rgISBAlwaysSorted:           list is always sorted
 *    - \b rgISBReverseSort:            invert sorting order
 *    - \b rgISBAlwaysReverseSorted:    list is always sorted in reverse order
 *
 *  - options for source and destination sub-lists
 *    - \b rgISBMoveSrcButtons:         move buttons for source elements
 *    - \b rgISBMoveDestButtons:        move buttons for destination elements
 */
class RGItemSelectionBox : public TGHorizontalFrame
{
  //------------------------------------------------------------
  /*! \object_doc{RGItemSelectionBox} */
  GObject(RGItemSelectionBox);
  //------------------------------------------------------------

  protected:
    UInt_t              list_w_min;           ///< List widget minimum width
    UInt_t              list_h_min;           ///< List widget minimum height

    UInt_t              options;              ///< Widget options

    GItemList           item_list;            ///< Input list of elements (global list)

    RGItemListBox       * src_box;            ///< Source selection box
    RGItemListBox       * dest_box;           ///< Destination selection box

    TGVerticalFrame     * w_center_frame;     ///< Central frame for buttons
    TGTextButton        * w_add_button;       ///< Add to selection button
    TGTextButton        * w_remove_button;    ///< Remove from selection button

  //------------------------------------------------------------
  //  Constructors / affectation / destructor
  public:
    RGItemSelectionBox ( TGWindow    *p,
                         const char  *txt_src  = NULL,
                         const char  *txt_dest = NULL,
                         const UInt_t opts     = 0,
                         const UInt_t w_min    = 80,
                         const UInt_t h_min    = 80 );
    
  protected:
    RGItemSelectionBox ( const RGItemSelectionBox &original );

  public:
    virtual ~RGItemSelectionBox ( );

  //------------------------------------------------------------
  // widgets functions
    virtual void              MapSubwindows      ( );
    virtual RGItemListBox   * GetSrcItemListBox  ( ) const;   // inline
    virtual RGItemListBox   * GetDestItemListBox ( ) const;   // inline
    virtual TGVerticalFrame * GetCenterFrame     ( ) const;   // inline

    virtual TGButton  * AddSrcButton    ( const char *text, const Int_t id, const char *tooltip = NULL );
    virtual TGButton  * AddSrcButton    ( TGButton *but, const Int_t id );
    virtual TGButton  * AddDestButton   ( const char *text, const Int_t id, const char *tooltip = NULL );
    virtual TGButton  * AddDestButton   ( TGButton *but, const Int_t id );
    virtual TGButton  * AddCenterButton ( const char *text, const Int_t id, const char *tooltip = NULL );
    virtual TGButton  * AddCenterButton ( TGButton *but, const Int_t id );

    virtual TGFrame   * AddSrcBottomFrame  ( TGFrame *f, TGLayoutHints *l = NULL );
    virtual TGFrame   * AddDestBottomFrame ( TGFrame *f, TGLayoutHints *l = NULL );

    // Lists functions
    virtual Int_t   AddItem ( const string & s, void *ptr = NULL, const Bool_t update = true);
    virtual Int_t   AddItem ( const GItem  & d, const Bool_t update = true);
    virtual Int_t   AddItem (       GItem  * d, const Bool_t update = true);

    virtual void    RemoveItem ( const Int_t n, const Bool_t update = true );

    virtual GItem     * GetItem     ( Int_t id ) const;
    virtual GSubItem  * GetSrcItem  ( Int_t id ) const;
    virtual GSubItem  * GetDestItem ( Int_t id ) const;

  protected:
    virtual void    RemoveSelectedItem ( const Bool_t update = true );
    virtual void    RemoveSubItems     ( GItem *supp, const Bool_t update = true, const Bool_t sub_signal = true );

  public:
    virtual void    SrcSelectionRemove  ( );
    virtual void    DestSelectionRemove ( );
  protected:
    virtual void    SelectionRemove ( RGItemListBox *ilb );

  public:
    // récupération des listes
    virtual GItemListIter   SrcBegin  ( ) const;    // inline
    virtual GItemListIter   SrcEnd    ( ) const;    // inline
    virtual GItemListIter   DestBegin ( ) const;    // inline
    virtual GItemListIter   DestEnd   ( ) const;    // inline
    virtual GItemListIter   Begin     ( ) const;    // inline
    virtual GItemListIter   End       ( ) const;    // inline
    virtual GItemListIter   Null      ( ) const;    // inline

    virtual Int_t           GetSize     ( ) const;  // inline
    virtual Int_t           GetSrcSize  ( ) const;  // inline
    virtual Int_t           GetDestSize ( ) const;  // inline

    // fonctions à usage interne (elles n'ont pas besoin d'être protégées)
    virtual void    UpdateSelectionBox ( );

    // Slots des widgets internes
    virtual Int_t   ItemToDest    ( const Int_t num, const Bool_t update = false );
    virtual Int_t   SrcItemToDest ( const Int_t num, const Bool_t update = false );

    virtual void    SrcDoubleClicked   ( Int_t n );
    virtual void    DestDoubleClicked  ( Int_t n );

    virtual void    SrcSelectionToDest ( );
    virtual void    DestSelectionToSrc ( );

    //----------------------------------------------------------
    //  SIGNALS
    virtual void  ItemRemoved          ( ULong_t ptr ); // *SIGNAL*
    virtual void  SrcItemRemoved       ( ULong_t ptr ); // *SIGNAL*
    virtual void  DestItemRemoved      ( ULong_t ptr ); // *SIGNAL*
    virtual void  CustomClicked        ( Int_t id );    // *SIGNAL*
    virtual void  SelectionChanged     ( );             // *SIGNAL*
    virtual void  SrcSelectionChanged  ( );             // *SIGNAL*
    virtual void  DestSelectionChanged ( );             // *SIGNAL*


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

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

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