widget.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2022
    by David White <dave@whitevine.net>
    Part of the Battle for Wesnoth Project https://www.wesnoth.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; either version 2 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.

    See the COPYING file for more details.
*/

#pragma once

#include "events.hpp"
#include "gui/core/top_level_drawable.hpp"
#include "sdl/rect.hpp"
#include "sdl/surface.hpp"

#include <string>

namespace gui {

// TODO: making widgets TLDs is horrible. Please move everything to GUI2.
class widget : public events::sdl_handler, public gui2::top_level_drawable
{
public:
    const rect& location() const;
    virtual void set_location(const SDL_Rect& rect);
    void set_location(int x, int y);
    void set_width(int w);
    void set_height(int h);
    void set_measurements(int w, int h);

    int width() const;
    int height() const;

    //focus() may gain the focus if the currently focused handler doesn't require this event
    bool focus(const SDL_Event* event);
    void set_focus(bool focus);

    virtual void hide(bool value = true);
    bool hidden() const;
    virtual void enable(bool new_val = true);
    bool enabled() const;

    void set_clip_rect(const SDL_Rect& rect);

    /** Indicate that the widget should be redrawn. */
    void queue_redraw();
    /** Indicate that a specific region of the screen should be redrawn.
      * This is in absolute drawing coordinates, and is not clipped. */
    void queue_redraw(const rect&);

    // Note: all that needs the dirty handling is the editor palette.
    void set_dirty(bool dirty=true);
    bool dirty() const;
    const std::string& id() const;
    void set_id(const std::string& id);

    void set_tooltip_string(const std::string& str);

    virtual void process_tooltip_string(int mousex, int mousey) override;

protected:
    widget(const bool auto_join=true);
    virtual ~widget();

public:
    /* draw_manager interface */

    /** Called by draw_manager to validate layout. */
    virtual void layout() override;
    /** Called by draw_manager when it believes a redraw is necessary. */
    virtual bool expose(const rect& region) override;
    /** The current draw location of the display, on the screen. */
    virtual rect screen_location() override { return location(); }

private:
    // This could be made public again, but GUI1 widgets are deprecated.
    // It's better to replace with GUI2 systems than to improve this.
    void draw();

protected:
    virtual void draw_contents() {}
    virtual void update_location(const SDL_Rect&) {};

    virtual void handle_event(const SDL_Event&) override {};
    bool focus_;        // Should user input be ignored?

    bool mouse_locked() const;

    void aquire_mouse_lock();
    void free_mouse_lock();

private:
    rect rect_;

    enum { UNINIT, HIDDEN, DIRTY, DRAWN } state_;
    bool enabled_;
    bool clip_;
    rect clip_rect_;

    std::string tooltip_text_;
    std::string id_;

    bool mouse_lock_local_;
    static bool mouse_lock_;

    friend class dialog;
};

}