uibaseobject.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Lammertink
 Date:          16/05/2001
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "uibasemod.h"
#include "namedobj.h"
 
class uiBody;
mFDQtclass(QWidget)
 
mExpClass(uiBase) uiBaseObject : public NamedCallBacker
{
public:
                                uiBaseObject(const char* nm, uiBody* = 0);
    virtual                     ~uiBaseObject();
 
                                // implementation: uiobj.cc
    void                        finalise();
    bool                        finalised() const;
    void                        clear();
 
    virtual void                translateText()         {}
    inline const uiBody*        body() const            { return body_; }
    inline uiBody*              body()                  { return body_; }
 
    static void                 addCmdRecorder(const CallBack&);
    static void                 removeCmdRecorder(const CallBack&);
 
    int  /* refnr */            beginCmdRecEvent(const char* msg=0);
    void                        endCmdRecEvent(int refnr,const char* msg=0);
 
    int  /* refnr */            beginCmdRecEvent(od_uint64 id,
                                                 const char* msg=0);
    void                        endCmdRecEvent(od_uint64 id,int refnr,
                                               const char* msg=0);
 
    virtual Notifier<uiBaseObject>& preFinalise()
                                { return finaliseStart; }
    virtual Notifier<uiBaseObject>& postFinalise()
                                { return finaliseDone; }
 
    virtual mQtclass(QWidget*)  getWidget() { return 0; }
    const mQtclass(QWidget*)    getWidget() const;
 
protected:
 
    void                        setBody( uiBody* b )    { body_ = b; }
 
    Notifier<uiBaseObject>      finaliseStart;
    Notifier<uiBaseObject>      finaliseDone;
 
private:
    int                         cmdrecrefnr_;
    uiBody*                     body_;
};
 
 
/*
CmdRecorder annotation to distinguish real user actions from actions
performed by program code. Should be used at start of each (non-const)
uiObject function that calls any uiBody/Qt function that may trigger a
signal received by the corresponding Messenger class (see i_q****.h).
Apart from a few notify handler functions, it will do no harm when
using this annotation unnecessarily.
*/
 
#define mBlockCmdRec            CmdRecStopper cmdrecstopper(this);
 
mExpClass(uiBase) CmdRecStopper
{
public:
                                CmdRecStopper(const uiBaseObject*);
                                ~CmdRecStopper();
 
    static void                 clearStopperList(const CallBacker* cmdrec);
 
    static bool                 isInStopperList(const uiBaseObject* obj);
};