ufoai/html/ui__lua_8h_source.html

/*

Copyright (C) 1997-2001 Id Software, Inc.


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 "../../common/scripts_lua.h"


// prototype

struct uiNode_t;

struct linkedList_t;


/* ui lua startup/shutdown */

void UI_InitLua (void);

void UI_ShutdownLua (void);


/* register and call ufo module onload callback */

void UI_RegisterHandler_OnLoad (LUA_FUNCTION fcn);

void UI_CallHandler_OnLoad (lua_State* L, const char* key);


/* lua script functions */

bool UI_ParseAndLoadLuaScript (const char* name, const char** text);

bool UI_ExecuteLuaEventScript (uiNode_t* node, LUA_EVENT event);

bool UI_ExecuteLuaEventScript_ParamList (uiNode_t* node, LUA_EVENT event, linkedList_t* params);

bool UI_ExecuteLuaEventScript_ReturnBool (uiNode_t* node, LUA_EVENT event, bool &result);

bool UI_ExecuteLuaEventScript_XY (uiNode_t* node, LUA_EVENT event, int x, int y);

bool UI_ExecuteLuaEventScript_DxDy (uiNode_t* node, LUA_EVENT event, int dx, int dy);

bool UI_ExecuteLuaEventScript_Key (uiNode_t* node, LUA_EVENT event, unsigned int key, unsigned short unicode);


bool UI_ExecuteLuaEventScript_DragDrop (uiNode_t* node, LUA_EVENT event, bool &result);

bool UI_ExecuteLuaEventScript_DragDrop_XY (uiNode_t* node, LUA_EVENT event, int x, int y, bool &result);

bool UI_ExecuteLuaEventScript_DragDrop_IsDropped (uiNode_t* node, LUA_EVENT event, bool isDropped, bool &result);


bool UI_ExecuteLuaMethod (uiNode_t* node, LUA_FUNCTION fcn, linkedList_t* params, int nparams);

bool UI_ExecuteLuaConFunc (uiNode_t* node, LUA_FUNCTION fcn);

bool UI_ExecuteLuaMethod_ByName (uiNode_t* node, const char* name, linkedList_t* params, int nparams);


/* lua uiNode create functions */

uiNode_t* UI_CreateControl (uiNode_t* parent, const char* type, const char* name, const char* super);

uiNode_t* UI_CreateComponent (const char* type, const char* name, const char* super);

uiNode_t* UI_CreateWindow (const char* type, const char* name, const char* super);


/* information */

void UI_PrintNodeTree (uiNode_t* node, int level = 0);

const char* UI_Node_TypeOf(uiNode_t* node);


key
unsigned int key
Definition cl_input.cpp:64

unicode
unsigned short unicode
Definition cl_input.cpp:65

level
level_locals_t level
Definition g_main.cpp:38

type
QGL_EXTERN GLint GLenum type
Definition r_gl.h:94

name
QGL_EXTERN GLuint GLsizei GLsizei GLint GLenum GLchar * name
Definition r_gl.h:110

scripts_lua.h
Header for lua script functions.

LUA_FUNCTION
int LUA_FUNCTION
callback signatures for functions defined in Lua
Definition scripts_lua.h:45

LUA_EVENT
int LUA_EVENT
holds a reference to a lua event handler
Definition scripts_lua.h:49

linkedList_t
Definition list.h:30

uiNode_t
Atomic structure used to define most of the UI.
Definition ui_nodes.h:80

UI_Node_TypeOf
const char * UI_Node_TypeOf(uiNode_t *node)
Definition ui_lua.cpp:529

UI_CreateControl
uiNode_t * UI_CreateControl(uiNode_t *parent, const char *type, const char *name, const char *super)
Create a new control inherited from a given node class or other node.
Definition ui_lua.cpp:428

UI_ExecuteLuaEventScript_DragDrop
bool UI_ExecuteLuaEventScript_DragDrop(uiNode_t *node, LUA_EVENT event, bool &result)
Executes a lua event handler for dragdrop interaction.
Definition ui_lua.cpp:211

UI_ExecuteLuaEventScript_DragDrop_XY
bool UI_ExecuteLuaEventScript_DragDrop_XY(uiNode_t *node, LUA_EVENT event, int x, int y, bool &result)
Executes a lua event handler for dragdrop interaction.
Definition ui_lua.cpp:238

UI_ExecuteLuaEventScript
bool UI_ExecuteLuaEventScript(uiNode_t *node, LUA_EVENT event)
Executes a lua event handler.
Definition ui_lua.cpp:71

UI_ExecuteLuaEventScript_XY
bool UI_ExecuteLuaEventScript_XY(uiNode_t *node, LUA_EVENT event, int x, int y)
Executes a lua event handler with (x,y) argument.
Definition ui_lua.cpp:143

UI_CreateWindow
uiNode_t * UI_CreateWindow(const char *type, const char *name, const char *super)
Create a window node with specified type and inheritance.
Definition ui_lua.cpp:618

UI_ExecuteLuaMethod
bool UI_ExecuteLuaMethod(uiNode_t *node, LUA_FUNCTION fcn, linkedList_t *params, int nparams)
Executes a lua based method defined on the behaviour class of a node.
Definition ui_lua.cpp:295

UI_ExecuteLuaEventScript_DragDrop_IsDropped
bool UI_ExecuteLuaEventScript_DragDrop_IsDropped(uiNode_t *node, LUA_EVENT event, bool isDropped, bool &result)
Executes a lua event handler for dragdrop interaction.
Definition ui_lua.cpp:266

UI_ParseAndLoadLuaScript
bool UI_ParseAndLoadLuaScript(const char *name, const char **text)
Parses and loads a .ufo file holding a lua script.
Definition ui_lua.cpp:386

UI_ExecuteLuaEventScript_Key
bool UI_ExecuteLuaEventScript_Key(uiNode_t *node, LUA_EVENT event, unsigned int key, unsigned short unicode)
Executes a lua event handler with (keycode,unicode) argument.
Definition ui_lua.cpp:189

UI_ShutdownLua
void UI_ShutdownLua(void)
Performs UI specific lua shutdown. Call this before CL_ShutdownLua.
Definition ui_lua.cpp:61

UI_ExecuteLuaMethod_ByName
bool UI_ExecuteLuaMethod_ByName(uiNode_t *node, const char *name, linkedList_t *params, int nparams)
Executes a lua based method defined on the behaviour class of a node.
Definition ui_lua.cpp:350

UI_CreateComponent
uiNode_t * UI_CreateComponent(const char *type, const char *name, const char *super)
Create a new component inherited from a given node class or other node.
Definition ui_lua.cpp:544

UI_InitLua
void UI_InitLua(void)
Performs UI specific initialization. Call this after CL_InitLua.
Definition ui_lua.cpp:55

UI_CallHandler_OnLoad
void UI_CallHandler_OnLoad(lua_State *L, const char *key)
Call the registered callback handler. This stub primarily exists should the signature of the call cha...
Definition ui_lua.cpp:372

UI_ExecuteLuaConFunc
bool UI_ExecuteLuaConFunc(uiNode_t *node, LUA_FUNCTION fcn)
Executes a lua based confunc node.
Definition ui_lua.cpp:323

UI_RegisterHandler_OnLoad
void UI_RegisterHandler_OnLoad(LUA_FUNCTION fcn)
Register global lua callback function called after loading the module.
Definition ui_lua.cpp:363

UI_ExecuteLuaEventScript_ParamList
bool UI_ExecuteLuaEventScript_ParamList(uiNode_t *node, LUA_EVENT event, linkedList_t *params)
Executes a lua event handler with string parameter list.
Definition ui_lua.cpp:91

UI_ExecuteLuaEventScript_DxDy
bool UI_ExecuteLuaEventScript_DxDy(uiNode_t *node, LUA_EVENT event, int dx, int dy)
Executes a lua event handler with (dx,dy) argument.
Definition ui_lua.cpp:166

UI_PrintNodeTree
void UI_PrintNodeTree(uiNode_t *node, int level=0)
Definition ui_lua.cpp:513

UI_ExecuteLuaEventScript_ReturnBool
bool UI_ExecuteLuaEventScript_ReturnBool(uiNode_t *node, LUA_EVENT event, bool &result)
Executes a lua event handler and returns the result as a boolean.
Definition ui_lua.cpp:116