ui_node_abstractscrollable.c

Go to the documentation of this file.

/*
Copyright (C) 2002-2010 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.

*/

#include "../ui_main.h"
#include "../ui_parse.h"
#include "../ui_font.h"
#include "../ui_render.h"
#include "../ui_actions.h"
#include "ui_node_abstractnode.h"
#include "ui_node_abstractscrollable.h"

#include "../../client.h" /* gettext _() */

#define EXTRADATA_TYPE abstractScrollableExtraData_t
#define EXTRADATA(node) UI_EXTRADATA(node, EXTRADATA_TYPE)

qboolean UI_AbstractScrollableNodeIsSizeChange (uiNode_t *node)
{
    assert(UI_NodeInstanceOf(node, "abstractscrollable"));

    if (node->size[0] != EXTRADATA(node).cacheSize[0]
        || node->size[1] != EXTRADATA(node).cacheSize[1])
    {
        EXTRADATA(node).cacheSize[0] = node->size[0];
        EXTRADATA(node).cacheSize[1] = node->size[1];
        return qtrue;
    }
    return qfalse;
}

qboolean UI_SetScroll (uiScroll_t *scroll, int viewPos, int viewSize, int fullSize)
{
    qboolean updated = qfalse;

    /* default values */
    if (viewPos == -1)
        viewPos = scroll->viewPos;
    if (viewSize == -1)
        viewSize = scroll->viewSize;
    if (fullSize == -1)
        fullSize = scroll->fullSize;

    /* fix limits */
    if (viewSize < 0)
        viewSize = 0;
    if (fullSize < 0)
        fullSize = 0;
    if (viewPos < 0)
        viewPos = 0;

    /* clap position */
    if (viewSize >= fullSize)
        viewPos = 0;
    else if (viewPos > fullSize - viewSize)
        viewPos = fullSize - viewSize;

    /* update */
    if (scroll->viewPos != viewPos) {
        scroll->viewPos = viewPos;
        updated = qtrue;
    }
    if (scroll->viewSize != viewSize) {
        scroll->viewSize = viewSize;
        updated = qtrue;
    }
    if (scroll->fullSize != fullSize) {
        scroll->fullSize = fullSize;
        updated = qtrue;
    }

    return updated;
}

qboolean UI_AbstractScrollableNodeSetY (uiNode_t *node, int viewPos, int viewSize, int fullSize)
{
    qboolean updated;
    assert(UI_NodeInstanceOf(node, "abstractscrollable"));

    updated = UI_SetScroll(&EXTRADATA(node).scrollY, viewPos, viewSize, fullSize);

    if (updated && EXTRADATA(node).onViewChange)
        UI_ExecuteEventActions(node, EXTRADATA(node).onViewChange);

    return updated;
}

static void UI_AbstractScrollableNodePageUp (uiNode_t *node, const uiCallContext_t *context) {
    const int pos = EXTRADATA(node).scrollY.viewPos - 10;
    UI_AbstractScrollableNodeSetY(node, (pos >= 0)?pos:0, -1, -1);
}

static void UI_AbstractScrollableNodePageDown (uiNode_t *node, const uiCallContext_t *context) {
    UI_AbstractScrollableNodeSetY(node, EXTRADATA(node).scrollY.viewPos + 10, -1, -1);
}

static void UI_AbstractScrollableNodeMoveUp (uiNode_t *node, const uiCallContext_t *context) {
    UI_AbstractScrollableNodeSetY(node, EXTRADATA(node).scrollY.viewPos - 1, -1, -1);
}

static void UI_AbstractScrollableNodeMoveDown (uiNode_t *node, const uiCallContext_t *context) {
    UI_AbstractScrollableNodeSetY(node, EXTRADATA(node).scrollY.viewPos + 1, -1, -1);
}

static void UI_AbstractScrollableNodeMoveHome (uiNode_t *node, const uiCallContext_t *context) {
    UI_AbstractScrollableNodeSetY(node, 0, -1, -1);
}

static void UI_AbstractScrollableNodeMoveEnd (uiNode_t *node, const uiCallContext_t *context) {
    UI_AbstractScrollableNodeSetY(node, EXTRADATA(node).scrollY.fullSize, -1, -1);
}

qboolean UI_AbstractScrollableNodeScrollY (uiNode_t *node, int offset)
{
    assert(UI_NodeInstanceOf(node, "abstractscrollable"));
    return UI_AbstractScrollableNodeSetY(node, EXTRADATA(node).scrollY.viewPos + offset, -1, -1);
}

static const value_t properties[] = {
    /* position of the vertical view (into the full number of elements the node contain) */
    {"viewpos", V_INT, UI_EXTRADATA_OFFSETOF(EXTRADATA_TYPE, scrollY.viewPos),  MEMBER_SIZEOF(EXTRADATA_TYPE, scrollY.viewPos)},
    /* size of the vertical view (proportional to the number of elements the node can display without moving) */
    {"viewsize", V_INT, UI_EXTRADATA_OFFSETOF(EXTRADATA_TYPE, scrollY.viewSize),  MEMBER_SIZEOF(EXTRADATA_TYPE, scrollY.viewSize)},
    /* full vertical size (proportional to the number of elements the node contain) */
    {"fullsize", V_INT, UI_EXTRADATA_OFFSETOF(EXTRADATA_TYPE, scrollY.fullSize),  MEMBER_SIZEOF(EXTRADATA_TYPE, scrollY.fullSize)},
    /* Called when one of the properties viewpos/viewsize/fullsize change */
    {"onviewchange", V_UI_ACTION, UI_EXTRADATA_OFFSETOF(EXTRADATA_TYPE, onViewChange), MEMBER_SIZEOF(EXTRADATA_TYPE, onViewChange)},

    /* Call it to vertically scroll the document up */
    {"pageup", V_UI_NODEMETHOD, ((size_t) UI_AbstractScrollableNodePageUp), 0},
    /* Call it to vertically scroll the document down */
    {"pagedown", V_UI_NODEMETHOD, ((size_t) UI_AbstractScrollableNodePageDown), 0},
    /* Call it to vertically scroll the document up */
    {"moveup", V_UI_NODEMETHOD, ((size_t) UI_AbstractScrollableNodeMoveUp), 0},
    /* Call it to vertically scroll the document down */
    {"movedown", V_UI_NODEMETHOD, ((size_t) UI_AbstractScrollableNodeMoveDown), 0},
    /* Call it to vertically reset the scroll position to 0 */
    {"movehome", V_UI_NODEMETHOD, ((size_t) UI_AbstractScrollableNodeMoveHome), 0},
    /* Call it to vertically move the scroll to the end of the document */
    {"moveend", V_UI_NODEMETHOD, ((size_t) UI_AbstractScrollableNodeMoveEnd), 0},

    {NULL, V_NULL, 0, 0}
};

void UI_RegisterAbstractScrollableNode (uiBehaviour_t *behaviour)
{
    behaviour->name = "abstractscrollable";
    behaviour->isAbstract = qtrue;
    behaviour->properties = properties;
    behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
}