ui_node_abstractoption.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/shared.h"
#include "ui_node_abstractscrollable.h"

struct uiAction_s;

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

    void doLayout(uiNode_t* node) override;
    int getCellWidth(uiNode_t* node) override;
    int getCellHeight(uiNode_t* node) override;
};

typedef struct {
    /* link to shared data (can be used if internal data is null) */
    int dataId;                         
    int versionId;                      
    const char* cvar;                   
    /* information */
    int count;                          
    int lineHeight;

    uiScroll_t scrollY;                 
    struct uiAction_s* onViewChange;    
    LUA_EVENT lua_onViewChange;         
    uiSprite_t* background;
} abstractOptionExtraData_t;

struct uiBehaviour_t;

void UI_RegisterAbstractOptionNode(uiBehaviour_t* behaviour);
void UI_AbstractOption_SortOptions(uiNode_t* node);

uiNode_t* UI_AbstractOption_GetFirstOption(uiNode_t* node);
const char* UI_AbstractOption_GetCurrentValue(uiNode_t* node);
void UI_AbstractOption_SetCurrentValue(uiNode_t* node, const char* value);

int UI_AbstractOption_GetDataId (uiNode_t* node);
int UI_AbstractOption_GetCount (uiNode_t* node);
const char* UI_AbstractOption_GetCvar (uiNode_t* node);

void UI_AbstractOption_SetDataId (uiNode_t* node, int id);
void UI_AbstractOption_SetDataIdByName (uiNode_t* node, const char* name);
void UI_AbstractOption_SetCvar (uiNode_t* node, const char* name);
void UI_AbstractOption_SetBackgroundByName(uiNode_t* node, const char* name);

int UI_AbstractOption_Scroll_Current (uiNode_t* node);
void UI_AbstractOption_Scroll_SetCurrent (uiNode_t* node, int pos);
int UI_AbstractOption_Scroll_ViewSize (uiNode_t* node);
void UI_AbstractOption_Scroll_SetViewSize (uiNode_t* node, int size);
int UI_AbstractOption_Scroll_FullSize (uiNode_t* node);
void UI_AbstractOption_Scroll_SetFullSize (uiNode_t* node, int size);