pawsdndbutton.h

Go to the documentation of this file.

/*
 * pawsdndbutton.h - Author: Joe Lyon
 *
 * Copyright (C) 2013 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program 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 General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
// pawsbutton.h: interface for the pawsDnDButton class.
//

#ifndef PAWS_DND_BUTTON_HEADER
#define PAWS_DND_BUTTON_HEADER

#include "paws/pawswidget.h"
#include "paws/pawsbutton.h"
#include "paws/pawsprogressbar.h"
#include "psslotmgr.h"

//#include "globals.h"
//#include "pscelclient.h"
//#include "net/clientmsghandler.h"
//#include "net/cmdhandler.h"
//#include "paws/pawsnumberpromptwindow.h"

#define DNDBUTTON_DRAGGING 9999

class pawsDnDButton : public pawsButton
{
public:
    pawsDnDButton();
    virtual ~pawsDnDButton();

    virtual bool Setup(iDocumentNode* node);
    bool SelfPopulate(iDocumentNode* node);

    virtual bool OnMouseDown(int button, int modifiers, int x, int y);
    virtual bool OnMouseUp(int button, int modifiers, int x, int y);
    virtual void MouseOver(bool value);

    virtual void Draw();
    void Start(csTicks startTicks, csTicks currentTicks, csTicks duration);

    iPawsImage* GetMaskingImage();

    void SetTextOffsetY( int offset ) 
    {
        upTextOffsetY = offset;
        downTextOffsetY = offset;
    }
    int GetTextOffsetY()
    {
        return upTextOffsetY;
    }
    void SetTextOffsetX( int offset ) 
    {
        upTextOffsetX = offset;
        downTextOffsetX = offset;
    }
    int GetTextOffsetX()
    {
        return upTextOffsetX;
    }
    void SetDrag(int isDragDrop)
    {
        dragDrop = isDragDrop;
    }
    bool PlaceItem(const char* imageName, const char* Name, const char* toolTip, const char* action);

    csArray<csString>* GetImageNameCallback()
    {
        return ImageNameCallback;
    }
    void SetImageNameCallback(csArray<csString>* in)
    {
        ImageNameCallback=in;
    }

    csArray<csString>* GetNameCallback()
    {
        return NameCallback;
    }
    void SetNameCallback(csArray<csString>* in)
    {
        NameCallback=in;
    }
    const char* GetName()
    {
        if(GetText())
            return GetText();
        return NULL;
    }

    csArray<csString>* GetActionCallback()
    {
        return ActionCallback;
    }
    void SetActionCallback(csArray<csString>* in)
    {
        ActionCallback=in;
    }

    void SetIndexBase(int indexBase)
    {
        this->indexBase=indexBase;
    }
    int GetIndexBase()
    {
        return indexBase;
    }

    void SetMaskingImage(const char* image);

    int ContainerID()
    {
        return containerID;
    }

    void SetAction(const char* act)
    {
        if( act!=NULL )
        {
            action=new csString( act );
        }
        else
        {
            action=NULL;
        }
    }

    void SetAction(csString* act)
    {
        if(ActionCallback)
        {
            ActionCallback->Get(id-indexBase).Replace(act);
        }
        action = act;
    }

    const char* GetAction()
    {
        if(action!=NULL)
        {
            if(!action->IsEmpty())
            {
                return action->GetData();
            }
        }
        return NULL;
    }

    const char* GetTooltip()
    {
        if(baseToolTip)
        {
            if(!baseToolTip.IsEmpty())
            {
                return baseToolTip.GetData();
            }
        }
        return NULL;
    }

    void SetIcon( const char* icon );
    const char* GetIcon();
    void ClearIcon();

    void SetDnDLock(bool locked)
    {
        DnDLock = locked;
    }

    bool GetDnDLock()
    {
        return DnDLock;
    }

    /***
     * Remove all contents of button.
     */
    void Clear();

    /***
     * Get Button index number
     */
    int GetButtonIndex()
    {
        return id-indexBase;
    }

    void SetDragDropInProgress(int val);
    int IsDragDropInProgress();

    void DrawMask();

    char const * GetFontName()
    {
        return fontName;
    }

    void EnableBackground( bool mode );

    virtual void OnUpdateData(const char* /*dataname*/, PAWSData &value);
 
    void SetToolTip( const char * tooltip );

    virtual void SetRelativeFrame(int x, int y, int width, int height);

    void SetWarnLevel( float val, bool low );
    void SetDangerLevel( float val, bool low );
    void SetFlashLevel( float val, bool low );
    void SetWarnMode( int );
    void SetDangerMode( int );
    void SetFlashMode( int );

protected:
    psSlotManager*       mgr;
    int                  dragDrop;
    int                  dragDropInProgress;
    csString*            action;
    int                  containerID;
    int                  indexBase;
    int                  editMode;
    pawsWidget*          Callback;
    csArray<csString>*   ImageNameCallback;
    csArray<csString>*   NameCallback;
    csArray<csString>*   ActionCallback;
    csString             backgroundBackup;
    csString             baseToolTip;

    float                warnLevel;
    bool                 warnLow;
    int                  warnMode;

    float                dangerLevel;
    bool                 dangerLow;
    int                  dangerMode;

    float                flashLevel;
    bool                 flashLow;
    int                  flashMode;

    virtual bool CheckKeyHandled(int keyCode);

    bool                DnDLock; // true = locked, false = enabled.
    pawsProgressBar*    spellProgress;
    csTicks             startTime,
                        castingTime,
                        lastToolTipTime;
};

//----------------------------------------------------------------------
CREATE_PAWS_FACTORY(pawsDnDButton);

#endif