FXBaseObject.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*                  Base of lots of non-widgets                                  *
*                                                                               *
*********************************************************************************
* Copyright (C) 2003 by Mathew Robertson.   All Rights Reserved.                *
*********************************************************************************
* This library is free software; you can redistribute it and/or                 *
* modify it under the terms of the GNU Lesser General Public                    *
* License as published by the Free Software Foundation; either                  *
* version 2.1 of the License, or (at your option) any later version.            *
*                                                                               *
* This library is distributed in the hope that it will be useful,               *
* but WITHOUT ANY WARRANTY; without even the implied warranty of                *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
* Lesser General Public License for more details.                               *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public              *
* License along with this library; if not, write to the Free Software           *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
*********************************************************************************/
#ifndef FXBASEOBJECT_H
#define FXBASEOBJECT_H


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <FXHash.h>
using namespace FX;
#ifndef FXOBJECT_H
#include <FXObject.h>
using namespace FX;
#endif
namespace FXEX {

#define FXMAPALL(func) {MKUINT(MINKEY,MINTYPE),MKUINT(MAXKEY,MAXTYPE),&func}

#define FXMAPKEY(key,func)  {MKUINT(key,MINTYPE),MKUINT(key,MAXTYPE),&func}


class /* FXAPI // patch by Daniel Krajzewicz 24.02.2004 */
            FXBaseObject : public FXObject {
    FXDECLARE(FXBaseObject)

protected:
    enum {
        FLAG_ENABLED  = 0x00000002,   // enabled
        FLAG_UPDATE   = 0x00000004,   // needs update
        FLAG_FOCUSED  = 0x00000010,   // has focus
        FLAG_DIRTY    = 0x00000020,   // dirty
        FLAG_RECALC   = 0x00000040,   // needs recalculation
        FLAG_DEFAULT  = 0x00000200,   // set to default
        FLAG_INITIAL  = 0x00000400,   // set to initial value
        FLAG_ACTIVE   = 0x00001000,   // active
        FLAG_CHANGED  = 0x00010000,   // changed
        FLAG_READONLY = 0x10000000    // read only
    };

private:
    FXApp        *app;             // application pointer

protected:
    FXObject     *target;          // application target
    FXSelector    message;         // application message
    void         *data;            // user data
    FXuint        datalen;         // length of user data
    FXuint        flags;           // state flags
    FXuint        options;         // option flags

public:
    enum {
        ID_NONE=0,
        ID_DELETE=6,
        ID_DISABLE,
        ID_ENABLE,
        ID_SETVALUE=17,
        ID_SETINTVALUE,
        ID_SETREALVALUE,
        ID_SETSTRINGVALUE,
        ID_SETINTRANGE,
        ID_SETREALRANGE,
        ID_GETINTVALUE,
        ID_GETREALVALUE,
        ID_GETSTRINGVALUE,
        ID_XML,
        ID_META,
        ID_COMMENT,
        ID_DOCUMENT,
        ID_TAG,
        ID_CONTENT,
        ID_LAST
    };

public:
    long onCmdEnable(FXObject*,FXSelector,void*);
    long onCmdDisable(FXObject*,FXSelector,void*);
    long onUpdate(FXObject*,FXSelector,void*);

public:
    FXBaseObject(FXObject *tgt=NULL,FXSelector sel=0);

    FXBaseObject(FXApp *a,FXObject *tgt=NULL,FXSelector sel=0);

    FXApp* getApp();

    FXObject* getTarget() {
        return target;
    }

    void setTarget(FXObject* tgt) {
        target=tgt;
    }

    FXSelector getSelector() {
        return message;
    }

    void setSelector(FXSelector sel) {
        message=sel;
    }

    void* getUserData() {
        return data;
    }

    void setUserData(void *d) {
        data=d;
    }

    FXuint getUserDataLen() {
        return datalen;
    }

    void setUserDataLen(FXuint len) {
        datalen=len;
    }

    FXbool isEnabled() {
        return (flags&FLAG_ENABLED)!=0;
    }

    virtual void enable() {
        flags|=FLAG_ENABLED;
    }

    virtual void disable() {
        flags&=~FLAG_ENABLED;
    }

    virtual FXbool isReadonly() {
        return (flags&FLAG_READONLY)!=0;
    }

    virtual void setReadonly(FXbool mode=TRUE);

    virtual void create() {}

    virtual void detach() {}

    virtual void destroy() {}

    virtual void save(FXStream& store) const;

    virtual void load(FXStream& store);

    virtual ~FXBaseObject();
};

} // namespace FXEX
#endif // FXBASEOBJECT_H