ui_node_abstractscrollable.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/mathlib.h"
#include "ui_node_abstractnode.h"

struct uiBehaviour_t;
struct uiAction_s;
struct uiNode_t;

class uiAbstractScrollableNode : public uiLocatedNode {
public:
    void initNode(uiNode_t* node) override;

    bool isSizeChange(uiNode_t* node);
    bool scrollY(uiNode_t* node, int offset);
    bool setScrollY(uiNode_t* node, int viewPos, int viewSize, int fullSize);

    void pageUp (uiNode_t* node);
    void pageDown (uiNode_t* node);
    void moveUp (uiNode_t* node);
    void moveDown (uiNode_t* node);
    void moveHome (uiNode_t* node);
    void moveEnd (uiNode_t* node);
};

struct uiScroll_t {
    int viewPos;            
    int viewSize;           
    int fullSize;           
    bool set(int viewPos, int viewSize, int fullSize);
    bool move(int viewPos);
    bool moveDelta(int deltaPos) {
        return move(this->viewPos + deltaPos);
    }
};

typedef struct {
    vec2_t cacheSize;       
    uiScroll_t scrollX;
    uiScroll_t scrollY;

    struct uiAction_s* onViewChange;    
    LUA_EVENT lua_onViewChange;         
} abstractScrollableExtraData_t;

void UI_RegisterAbstractScrollableNode(uiBehaviour_t* behaviour);