view.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 GOT_VIEWS_VIEW_H
#define GOT_VIEWS_VIEW_H

#include "common/text-to-speech.h"
#include "got/events.h"
#include "got/gfx/gfx_chunks.h"

namespace Got {
namespace Views {

class View : public UIElement {
private:
    UIElement *_focusedElement = nullptr;

    void checkFocusedControl(const Common::Point &mousePos);

    UIElement *getElementAtPos(const Common::Point &pos) const;

protected:
    void playSound(int index, bool priority_override);
    void playSound(const Gfx::GraphicChunk &src);

    void musicPlay(int num, bool override);
    void musicPlay(const char *name, bool override);
    void musicPause();
    void musicResume();
    void musicStop();
    bool musicIsOn() const;

    void fadeOut();
    void fadeIn(const byte *pal = nullptr);

#ifdef USE_TTS
    void sayText(const Common::String &text, Common::TextToSpeechManager::Action action = Common::TextToSpeechManager::INTERRUPT);
#endif

public:
    View(const Common::String &name, UIElement *uiParent) : UIElement(name, uiParent) {}
    View(const Common::String &name) : UIElement(name) {}
    virtual ~View() {}

    bool msgFocus(const FocusMessage &msg) override;
    bool msgUnfocus(const UnfocusMessage &msg) override;
    bool msgMouseMove(const MouseMoveMessage &msg) override;
    bool msgMouseDown(const MouseDownMessage &msg) override;
    bool msgMouseUp(const MouseUpMessage &msg) override;
};

} // namespace Views
} // namespace Got

#endif