pawsbutton.h

Go to the documentation of this file.

/*
 * pawsbutton.h - Author: Andrew Craig
 *
 * Copyright (C) 2003 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 pawsButton class.
//

#ifndef PAWS_BUTTON_HEADER
#define PAWS_BUTTON_HEADER

#include "pawswidget.h"

/* Types of flash buttons, used in chat window */
enum FLASH_STATE
{
    FLASH_REGULAR = 0,
    FLASH_HIGHLIGHT,
    FLASH_SPECIAL
};


class pawsButton : public pawsWidget
{
public:
    pawsButton();
    pawsButton(const pawsButton &pb);
    virtual ~pawsButton();

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

    void SetUpImage(const csString &image);
    void SetDownImage(const csString &image);
    void SetGreyUpImage(const csString &greyUpImage);
    void SetGreyDownImage(const csString &greyDownImage);

    /* Specify the image to use for special flashing in chat window */
    void SetOnSpecialImage(const csString &image);

    void SetSound(const char* sound);

    virtual void Draw();

    virtual bool OnMouseEnter();
    virtual bool OnMouseExit();
    virtual bool OnMouseDown(int button, int modifiers, int x, int y);
    virtual bool OnMouseUp(int button, int modifiers, int x, int y);
    virtual bool OnKeyDown(utf32_char keyCode, utf32_char key, int modifiers);

    virtual bool IsDown()
    {
        return down;
    }
    virtual void SetState(bool isDown, bool publish=true);
    virtual bool GetState()
    {
        return down;
    }
    virtual void SetToggle(bool t)
    {
        toggle = t;
    }
    virtual void SetEnabled(bool enabled);
    virtual bool IsEnabled() const;
    virtual void SetNotify(pawsWidget* widget);

    void SetText(const char* text);
    const char* GetText()
    {
        return buttonLabel.GetData();
    }

    /* Button flashing used mainly in chatwindow */
    virtual void Flash(bool state, FLASH_STATE type = FLASH_REGULAR)
    {
        if(state && !down)
        {
            flash = 1;
        }
        else
        {
            flash = 0;
            if(flashtype == FLASH_HIGHLIGHT)
                SetColour(originalFontColour);
        }
        flashtype = type;
    }


protected:

    virtual bool CheckKeyHandled(int keyCode);

    bool down;

    csRef<iPawsImage> pressedImage;

    csRef<iPawsImage> releasedImage;

    csRef<iPawsImage> greyUpImage;
    csRef<iPawsImage> greyDownImage;

    csRef<iPawsImage> specialFlashImage;

    bool toggle;

    csString buttonLabel;

    char keybinding;

    pawsWidget* notify;

    int style;

    bool enabled;

    int flash;

    FLASH_STATE flashtype;

    csString sound_click;
    int upTextOffsetX;
    int upTextOffsetY;
    int downTextOffsetX;
    int downTextOffsetY;

    int originalFontColour;

    bool changeOnMouseOver;
};

//----------------------------------------------------------------------
CREATE_PAWS_FACTORY(pawsButton);

#endif