button.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef STARK_UI_BUTTON_H
#define STARK_UI_BUTTON_H

#include "engines/stark/services/staticprovider.h"

#include "common/scummsys.h"
#include "common/rect.h"
#include "common/str.h"

namespace Stark {

class VisualExplodingImage;
class VisualFlashingImage;
class VisualImageXMG;
class VisualText;

namespace Resources {
class Anim;
}

class Button {
public:
    enum HintAlign { kAlignLeft, kAlignRight };

    Button(const Common::String &text, StaticProvider::UIElement stockElement, const Common::Point &pos, HintAlign align, const Common::Point &hintPos);
    ~Button();

    void setPosition(const Common::Point &pos) { _position = pos; }
    void setUIElement(const StaticProvider::UIElement &stockElement) { _stockElement = stockElement; }

    void showButtonHint();
    void render();
    bool containsPoint(const Common::Point &point);

    void resetHintVisual();

    void goToAnimStatement(int animScriptItemIndex);

    void startImageExplosion(VisualImageXMG *image);

    void stopImageExplosion();

    void startImageFlashing(VisualImageXMG *image);

    void stopImageFlashing();

private:
    StaticProvider::UIElement _stockElement;
    Common::Point _position;
    Common::Point _hintPosition;
    Common::String _text;
    VisualText *_mouseText;
    VisualExplodingImage *_explodingImageAnimation;
    VisualFlashingImage *_flashingImageAnimation;
    const HintAlign _align;
    bool _renderHint;
};

} // End of namespace Stark

#endif // STARK_UI_BUTTON_H