uichecklist.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          Sep 2011
________________________________________________________________________

-*/

#include "uitoolsmod.h"
#include "uigroup.h"
class uiLabel;
class uiCheckBox;
class BufferStringSet;

mExpClass(uiTools) uiCheckList : public uiGroup
{
public:

    enum Pol            { Unrel, NotAll, OneMinimum, OneOnly, MaybeOne,
                          Chain1st, ChainAll };

                        uiCheckList(uiParent*,Pol=Unrel,
                                    OD::Orientation orient=OD::Vertical);

    void                setLabel(const uiString&);
    uiCheckList&        addItem(const uiString& txt,const char* iconfnm=0);
    uiCheckList&        addItems(const BufferStringSet&);
    uiCheckList&        addItems(const uiStringSet&);

    Pol                 pol() const             { return pol_; }
    OD::Orientation     orientation() const     { return orientation_; }
    inline bool         isHor() const { return orientation_ == OD::Horizontal; }

    int                 size() const            { return boxs_.size(); }
    bool                isChecked(int) const;
    uiCheckList&        setChecked(int,bool);
    int                 firstChecked() const;
    int                 lastChecked() const;

    Notifier<uiCheckList> changed;
    uiCheckBox*         clicked()               { return clicked_; }

protected:

    const Pol           pol_;
    const OD::Orientation orientation_;
    ObjectSet<uiCheckBox> boxs_;
    uiGroup*            grp_;
    uiLabel*            lbl_;
    uiCheckBox*         clicked_;

    void                setBox(int,bool chkd,bool shw=true);

    void                initObj(CallBacker*);
    void                boxChk(CallBacker*);

    void                ensureOne(bool);
    void                handleRadio(bool);
    void                handleChain();

public:

                        // use this to do special things, like set tooltips
    uiCheckBox*         box( int idx )          { return boxs_[idx]; }
    const uiCheckBox*   box( int idx ) const    { return boxs_[idx]; }

};