ui_node_abstractnode.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

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; 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.

*/

#pragma once

#include "../../../shared/cxx.h"
#include "../ui_nodes.h"
#include "../ui_node.h"

struct uiBehaviour_t;

class uiNode {
public:
    /* system allocation */

    virtual void onLoading(uiNode_t* node);
    virtual void onLoaded(uiNode_t* node);
    virtual void clone(uiNode_t const* source, uiNode_t* clone);
    virtual void initNode(uiNode_t* node);
    virtual void initNodeDynamic(uiNode_t* node);
    virtual void deleteNode(uiNode_t* node);

    /* system callback */

    virtual void onWindowOpened(uiNode_t* node, linkedList_t* params);
    virtual void onWindowClosed(uiNode_t* node);
    virtual void onWindowActivate(uiNode_t* node);
    virtual void onActivate(uiNode_t* node);
    virtual void onPropertyChanged(uiNode_t* node, const value_t* property);

    virtual ~uiNode() {}
};

typedef SharedPtr<uiNode> UINodePtr;

class uiLocatedNode : public uiNode {
public:
    virtual void draw(uiNode_t* node) {}
    virtual void drawTooltip(const uiNode_t* node, int x, int y) const;
    virtual void drawOverWindow(uiNode_t* node) {}

    virtual void doLayout(uiNode_t* node);
    virtual void onSizeChanged(uiNode_t* node);

    /* mouse events */

    virtual void onLeftClick(uiNode_t* node, int x, int y);
    virtual void onRightClick(uiNode_t* node, int x, int y);
    virtual void onMiddleClick(uiNode_t* node, int x, int y);
    virtual bool onScroll(uiNode_t* node, int deltaX, int deltaY);
    virtual void onMouseMove(uiNode_t* node, int x, int y) {}
    virtual void onMouseDown(uiNode_t* node, int x, int y, int button) {}
    virtual void onMouseUp(uiNode_t* node, int x, int y, int button) {}
    virtual bool onMouseLongPress(uiNode_t* node, int x, int y, int button) {
        return false;
    }
    virtual void onMouseEnter(uiNode_t* node);
    virtual void onMouseLeave(uiNode_t* node);
    virtual void onCapturedMouseMove(uiNode_t* node, int x, int y) {}
    virtual void onCapturedMouseLost(uiNode_t* node) {}
    virtual bool onStartDragging(uiNode_t* node, int startX, int startY, int currentX, int currentY, int button) {
        return false;
    }

    /* drag and drop callback */

    virtual bool onDndEnter(uiNode_t* node);
    virtual bool onDndMove(uiNode_t* node, int x, int y);
    virtual void onDndLeave(uiNode_t* node);
    virtual bool onDndDrop(uiNode_t* node, int x, int y);
    virtual bool onDndFinished(uiNode_t* node, bool isDropped);

    /* focus and keyboard events */
    virtual void onFocusGained(uiNode_t* node);
    virtual void onFocusLost(uiNode_t* node);
    virtual bool onKeyPressed(uiNode_t* node, unsigned int key, unsigned short unicode);
    virtual bool onKeyReleased(uiNode_t* node, unsigned int key, unsigned short unicode);

    virtual void getClientPosition(uiNode_t const* node, vec2_t position) {}
    virtual int getCellWidth (uiNode_t* node) {return 1;}
    virtual int getCellHeight (uiNode_t* node) {return 1;}

};

void UI_RegisterAbstractNode(uiBehaviour_t*);