uiobj.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:          25/08/1999
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "uibasemod.h"
#include "uibaseobject.h"
#include "uigeom.h"
#include "uilayout.h"
#include "uistring.h"
#include "color.h"
 
mFDQtclass(QWidget)
mFDQtclass(QString)
class MouseCursor;
class uiFont;
class uiObjectBody;
class uiParent;
class uiMainWin;
class i_LayoutItem;
class uiPixmap;
class uiObjEventFilter;
 
 
mExpClass(uiBase) uiObject : public uiBaseObject
{
    friend class        uiObjectBody;
    friend class        i_LayoutItem;
 
public:
                        ~uiObject();
 
    enum                SzPolicy{ Undef, Small, Medium, Wide,
                                  SmallVar, MedVar, WideVar,
                                  SmallMax, MedMax, WideMax };
 
    void                setHSzPol(SzPolicy);
    void                setVSzPol(SzPolicy);
    SzPolicy            szPol( bool hor=true) const;
 
    virtual int         width() const;  
    virtual int         height() const; 
 
    virtual void        setName(const char*);
 
    void                setToolTip(const uiString&);
    const uiString&     toolTip() const;
    static void         updateToolTips();
 
    void                translateText();
 
    void                display(bool yn,bool shrink=false,bool maximized=false);
    void                setFocus();
    bool                hasFocus() const;
    void                disabFocus();
 
    virtual void        setCursor(const MouseCursor&);
    bool                isCursorInside() const;
 
    virtual void        setStyleSheet(const char*);
    virtual Color       backgroundColor() const;
    Color               roBackgroundColor() const;
    virtual void        setBackgroundColor(const Color&);
    virtual void        setBackgroundPixmap(const uiPixmap&);
    virtual void        setTextColor(const Color&);
    void                setSensitive(bool yn=true);
    bool                isSensitive() const     { return sensitive(); }
    bool                sensitive() const;
    bool                visible() const;
    bool                isDisplayed() const;
    virtual bool        isEmpty() const { return false; }
 
    int                 prefHNrPics() const;
    virtual void        setPrefWidth(int);
    void                setPrefWidthInChar(int);
    void                setPrefWidthInChar(float);
    void                setMinimumWidth(int);
    void                setMaximumWidth(int);
    int                 prefVNrPics() const;
    virtual void        setPrefHeight(int);
    void                setPrefHeightInChar(int);
    void                setPrefHeightInChar(float);
    void                setMinimumHeight(int);
    void                setMaximumHeight(int);
 
    void                setStretch(int hor,int ver);
 
 
    void                attach(constraintType,int margin=-1);
    void                attach(constraintType,uiObject*,int margin=-1,
                                bool reciprocal=true);
    void                attach(constraintType,uiParent*,int margin=-1,
                                bool reciprocal=true);
 
    static void         setTabOrder(uiObject* first, uiObject* second);
 
    void                setFont(const uiFont&);
    const uiFont*       font() const;
    void                setCaption(const uiString&);
 
 
    void                shallowRedraw(CallBacker* =0)   { reDraw( false ); }
    void                deepRedraw(CallBacker* =0)      { reDraw( true ); }
    void                reDraw(bool deep);
 
    uiSize              actualSize(bool include_border=true) const;
 
    uiParent*           parent()                        { return parent_; }
    const uiParent*     parent() const
                            { return const_cast<uiObject*>(this)->parent(); }
    void                reParent(uiParent*);
 
    uiMainWin*          mainwin();
 
    mQtclass(QWidget*)  getWidget() { return qwidget(); }
    mQtclass(QWidget*)  qwidget();
    const mQtclass(QWidget*)    qwidget() const
                              { return const_cast<uiObject*>(this)->qwidget(); }
 
    virtual bool        handleLongTabletPress();
 
    virtual const ObjectSet<uiBaseObject>* childList() const    { return 0; }
 
    Notifier<uiObject>  closed;
    void                close();
 
 
    CNotifier<uiObject,uiRect&> setGeometry;
 
    static int          baseFldSize();
    static int          iconSize();
 
protected:
                        uiObject(uiParent*,const char* nm);
                        uiObject(uiParent*,const char* nm,uiObjectBody&);
 
    virtual bool        closeOK()       { closed.trigger(); return true; }
 
    void                triggerSetGeometry(const i_LayoutItem*, uiRect&);
 
    void                updateToolTip(CallBacker* = 0);
 
    uiString            tooltip_;
 
    uiObjEventFilter*   uiobjeventfilter_;
 
private:
    uiParent*           parent_;
 
public:
    mDeprecated         ("Use actualSize")
    uiSize              actualsize(bool inclborder=true) const
                        { return actualSize(inclborder); }
 
    mDeprecated         ("Use uiString")
    void                setToolTip( const char* txt )
                        { setToolTip(toUiString(txt)); }
};
 
 
#define mTemplTypeDef(fromclass,templ_arg,toclass) \
        typedef fromclass<templ_arg> toclass;
#define mTemplTypeDefT(fromclass,templ_arg,toclass) \
        mTemplTypeDef(fromclass,templ_arg,toclass)
 
 
#define mUsrEvGuiThread    mQtclass(QEvent)::Type( mQtclass(QEvent)::User + 0 )
#define mUsrEvPopUpReady   mQtclass(QEvent)::Type( mQtclass(QEvent)::User + 1 )
#define mUsrEvLongTabletPress  mQtclass(QEvent)::Type(mQtclass(QEvent)::User+2)