void UI_RegisterTextEntryNode (uiBehaviour_t* behaviour)
{
behaviour->name = "textentry";
behaviour->manager = UINodePtr(new uiTextEntryNode());
behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
/* Call back event called when we click on the node. If the click select the node,
* it called before we start the cvar edition.
*/
UI_RegisterOveridedNodeProperty(behaviour, "onClick");
/* Call back event (like click...) fired when the text is changed, after
* validation. An abort of the edition dont fire this event.
*/
UI_RegisterOveridedNodeProperty(behaviour, "onChange");
/* Custom the draw behaviour by hiding each character of the text with a star (''*''). */
UI_RegisterExtradataNodeProperty(behaviour, "isPassword", V_BOOL, textEntryExtraData_t, isPassword);
/* ustom the mouse event behaviour. When we are editing the text, if we click out of the node, the edition is aborted. Changes on
* the text are canceled, and no change event are fired.
*/
UI_RegisterExtradataNodeProperty(behaviour, "clickOutAbort", V_BOOL, textEntryExtraData_t, clickOutAbort);
/* Cursor position (offset of next UTF-8 char to the right) */
UI_RegisterExtradataNodeProperty(behaviour, "cursorPosition", V_INT, textEntryExtraData_t, cursorPosition);
/* Call it when we abort the edition */
UI_RegisterExtradataNodeProperty(behaviour, "onAbort", V_UI_ACTION, textEntryExtraData_t, onAbort);
/* Call it to force node edition */
UI_RegisterNodeMethod(behaviour, "edit", UI_TextEntryNodeFocus);
/* Sprite used to display the background */
UI_RegisterExtradataNodeProperty(behaviour, "background", V_UI_SPRITEREF, EXTRADATA_TYPE, background);
}
void UI_RegisterCvarFuncNode (uiBehaviour_t *behaviour)
{
behaviour->name = "cvarlistener";
behaviour->isVirtual = true;
behaviour->isFunction = true;
behaviour->manager = UINodePtr(new uiCvarNode());
/* Force to bind the node to the cvar */
UI_RegisterNodeMethod(behaviour, "forceBind", UI_CvarListenerNodeForceBind);
}
void UI_RegisterEditorNode (uiBehaviour_t *behaviour)
{
behaviour->name = "editor";
behaviour->manager = new uiEditorNode();
/* start edition mode */
UI_RegisterNodeMethod(behaviour, "start", UI_EditorNodeStart);
/* stop edition mode */
UI_RegisterNodeMethod(behaviour, "stop", UI_EditorNodeStop);
/* select the next node (according to the current one) */
UI_RegisterNodeMethod(behaviour, "selectnext", UI_EditorNodeSelectNext);
/* select the parent node (according to the current one) */
UI_RegisterNodeMethod(behaviour, "selectparent", UI_EditorNodeSelectParent);
/* select first child node (according to the current one) */
UI_RegisterNodeMethod(behaviour, "selectfirstchild", UI_EditorNodeSelectFirstChild);
Cmd_AddCommand("ui_extract", UI_EditorNodeExtract_f, "Extract position and size of nodes into a file");
Cmd_AddParamCompleteFunction("ui_extract", UI_CompleteWithWindow);
}
void UI_RegisterGeoscapeNode (uiBehaviour_t* behaviour)
{
behaviour->name = "geoscape";
behaviour->manager = UINodePtr(new uiGeoscapeNode());
behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
/* Use a right padding. */
UI_RegisterExtradataNodeProperty(behaviour, "padding-right", V_FLOAT, EXTRADATA_TYPE, paddingRight);
/* Call it to zoom out of the map */
UI_RegisterNodeMethod(behaviour, "zoomin", UI_GeoscapeNodeZoomIn);
/* Call it to zoom into the map */
UI_RegisterNodeMethod(behaviour, "zoomout", UI_GeoscapeNodeZoomOut);
Cmd_AddCommand("map_zoom", UI_GeoscapeNodeZoom_f);
Cmd_AddCommand("map_scroll", UI_GeoscapeNodeScroll_f);
cl_3dmap = Cvar_Get("cl_3dmap", "1", CVAR_ARCHIVE, "3D geoscape or flat geoscape");
cl_3dmapAmbient = Cvar_Get("cl_3dmapAmbient", "0", CVAR_ARCHIVE, "3D geoscape ambient lighting factor");
cl_mapzoommax = Cvar_Get("cl_mapzoommax", "6.0", CVAR_ARCHIVE, "Maximum geoscape zooming value");
cl_mapzoommin = Cvar_Get("cl_mapzoommin", "1.0", CVAR_ARCHIVE, "Minimum geoscape zooming value");
}
void UI_RegisterOptionTreeNode (uiBehaviour_t *behaviour)
{
behaviour->name = "optiontree";
behaviour->extends = "abstractoption";
behaviour->manager = UINodePtr(new uiOptionTreeNode());
behaviour->drawItselfChild = true;
/* Call this to toggle the node status. */
UI_RegisterNodeMethod(behaviour, "setselectedvalue", UI_OptionTreeSetSelectedValue);
/* Sprite used to display the background */
UI_RegisterExtradataNodeProperty(behaviour, "background", V_UI_SPRITEREF, EXTRADATA_TYPE, background);
}
void UI_RegisterAbstractScrollableNode (uiBehaviour_t *behaviour)
{
behaviour->name = "abstractscrollable";
behaviour->manager = UINodePtr(new uiAbstractScrollableNode());
behaviour->isAbstract = true;
behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
/* position of the vertical view (into the full number of elements the node contain) */
UI_RegisterExtradataNodeProperty(behaviour, "viewpos", V_INT, EXTRADATA_TYPE, scrollY.viewPos);
/* size of the vertical view (proportional to the number of elements the node can display without moving) */
UI_RegisterExtradataNodeProperty(behaviour, "viewsize", V_INT, EXTRADATA_TYPE, scrollY.viewSize);
/* full vertical size (proportional to the number of elements the node contain) */
UI_RegisterExtradataNodeProperty(behaviour, "fullsize", V_INT, EXTRADATA_TYPE, scrollY.fullSize);
/* Called when one of the properties viewpos/viewsize/fullsize change */
UI_RegisterExtradataNodeProperty(behaviour, "onviewchange", V_UI_ACTION, EXTRADATA_TYPE, onViewChange);
/* Call it to vertically scroll the document up */
UI_RegisterNodeMethod(behaviour, "pageup", UI_AbstractScrollableNodePageUp);
/* Call it to vertically scroll the document down */
UI_RegisterNodeMethod(behaviour, "pagedown", UI_AbstractScrollableNodePageDown);
/* Call it to vertically scroll the document up */
UI_RegisterNodeMethod(behaviour, "moveup", UI_AbstractScrollableNodeMoveUp);
/* Call it to vertically scroll the document down */
UI_RegisterNodeMethod(behaviour, "movedown", UI_AbstractScrollableNodeMoveDown);
/* Call it to vertically reset the scroll position to 0 */
UI_RegisterNodeMethod(behaviour, "movehome", UI_AbstractScrollableNodeMoveHome);
/* Call it to vertically move the scroll to the end of the document */
UI_RegisterNodeMethod(behaviour, "moveend", UI_AbstractScrollableNodeMoveEnd);
}
void UI_RegisterCheckBoxNode (uiBehaviour_t *behaviour)
{
behaviour->name = "checkbox";
behaviour->extends = "abstractvalue";
behaviour->manager = UINodePtr(new uiCheckBoxNode());
behaviour->extraDataSize = sizeof(EXTRADATA_TYPE);
/** Sprite used as an icon for checked state */
UI_RegisterExtradataNodeProperty(behaviour, "iconChecked", V_UI_SPRITEREF, EXTRADATA_TYPE, iconChecked);
/** Sprite used as an icon for unchecked state */
UI_RegisterExtradataNodeProperty(behaviour, "iconUnchecked", V_UI_SPRITEREF, EXTRADATA_TYPE, iconUnchecked);
/** Sprite used as an icon for indeterminate state */
UI_RegisterExtradataNodeProperty(behaviour, "iconIndeterminate", V_UI_SPRITEREF, EXTRADATA_TYPE, iconIndeterminate);
/** Sprite used as a background */
UI_RegisterExtradataNodeProperty(behaviour, "background", V_UI_SPRITEREF, EXTRADATA_TYPE, background);
/* Call it to toggle the node status. */
UI_RegisterNodeMethod(behaviour, "toggle", UI_CheckBoxNodeCallActivate);
}
void UI_RegisterAbstractNode (uiBehaviour_t* behaviour)
{
behaviour->name = "abstractnode";
behaviour->isAbstract = true;
behaviour->manager = UINodePtr(new uiLocatedNode());
/* Top-left position of the node */
UI_RegisterNodeProperty(behaviour, "pos", V_POS, uiNode_t, box.pos);
/* Size of the node */
propertySize = UI_RegisterNodeProperty(behaviour, "size", V_POS, uiNode_t, box.size);
/* Width of the node (see also <code>size</code>) */
propertyWidth = UI_RegisterNodeProperty(behaviour, "width", V_FLOAT, uiNode_t, box.size[0]);
/* Height of the node (see also <code>size</code>) */
propertyHeight = UI_RegisterNodeProperty(behaviour, "height", V_FLOAT, uiNode_t, box.size[1]);
/* Left position of the node (see also <code>pos</code>) */
UI_RegisterNodeProperty(behaviour, "left", V_FLOAT, uiNode_t, box.pos[0]);
/* Top position of the node (see also <code>pos</code>) */
UI_RegisterNodeProperty(behaviour, "top", V_FLOAT, uiNode_t, box.pos[1]);
/* If true, the node name is indexed into the window. We can access to the node with
* the path "windowName#nodeName"
*/
UI_RegisterNodeProperty(behaviour, "indexed", V_BOOL, uiNode_t, indexed);
/* If true, the node is not displayed nor or activatable. */
propertyInvis = UI_RegisterNodeProperty(behaviour, "invis", V_BOOL, uiNode_t, invis);
/* If true, the node is disabled. Few nodes support it, fell free to request an update. */
UI_RegisterNodeProperty(behaviour, "disabled", V_BOOL, uiNode_t, disabled);
/* If true, the node is not ''tangible''. We click through it, then it will not receive mouse event. */
UI_RegisterNodeProperty(behaviour, "ghost", V_BOOL, uiNode_t, ghost);
/* Flashing effect. */
UI_RegisterNodeProperty(behaviour, "flash", V_BOOL, uiNode_t, flash);
/* Speed of the flashing effect */
UI_RegisterNodeProperty(behaviour, "flashspeed", V_FLOAT, uiNode_t, flashSpeed);
/* Border size we want to display. */
UI_RegisterNodeProperty(behaviour, "border", V_INT, uiNode_t, border);
/* Padding size we want to use. Few node support it. */
UI_RegisterNodeProperty(behaviour, "padding", V_INT, uiNode_t, padding);
/* Background color we want to display. */
UI_RegisterNodeProperty(behaviour, "bgcolor", V_COLOR, uiNode_t, bgcolor);
/* Border color we want to display. */
UI_RegisterNodeProperty(behaviour, "bordercolor", V_COLOR, uiNode_t, bordercolor);
/*
* Used to set the position of the node when the parent use a layout manager.
* Else it do nothing.
* Available values are: LAYOUTALIGN_TOPLEFT, LAYOUTALIGN_TOP, LAYOUTALIGN_TOPRIGHT,
* LAYOUTALIGN_LEFT, LAYOUTALIGN_MIDDLE, LAYOUTALIGN_RIGHT, LAYOUTALIGN_BOTTOMLEFT,
* LAYOUTALIGN_BOTTOM, LAYOUTALIGN_BOTTOMRIGHT, LAYOUTALIGN_FILL.
* Allowed value depend the layout manager used. The update to date list is into
* ui_node_panel.c
* @image html http://ufoai.org/wiki/images/Layout.png
*/
UI_RegisterNodeProperty(behaviour, "align", V_INT, uiNode_t, align);
/*
* Used share an int, only used by 1 behaviour
* @todo move it to the right behaviour, delete it
*/
UI_RegisterNodeProperty(behaviour, "num", V_INT, uiNode_t, num);
/* Tooltip we want to use. */
UI_RegisterNodeProperty(behaviour, "tooltip", V_CVAR_OR_LONGSTRING, uiNode_t, tooltip);
/* Text the node will display.
*/
UI_RegisterNodeProperty(behaviour, "string", V_CVAR_OR_LONGSTRING, uiNode_t, text);
/* Text font the node will use.
* @todo use V_REF_OF_STRING when its possible ('font' is never a cvar).
*/
UI_RegisterNodeProperty(behaviour, "font", V_CVAR_OR_STRING, uiNode_t, font);
/* Text color the node will use. */
UI_RegisterNodeProperty(behaviour, "color", V_COLOR, uiNode_t, color);
/* Text color the node will use when something is selected. */
UI_RegisterNodeProperty(behaviour, "selectcolor", V_COLOR, uiNode_t, selectedColor);
/* Flashing color */
UI_RegisterNodeProperty(behaviour, "flashcolor", V_COLOR, uiNode_t, flashColor);
/* Alignement of the text into the node, or elements into blocks. */
UI_RegisterNodeProperty(behaviour, "contentalign", V_UI_ALIGN, uiNode_t, contentAlign);
/* When <code>invis</code> property is false (default value);
* this condition say if the node is visible or not. It use a script expression.
*/
UI_RegisterNodeProperty(behaviour, "visiblewhen", V_UI_IF, uiNode_t, visibilityCondition);
/* Called when the user click with left button into the node. */
UI_RegisterNodeProperty(behaviour, "onclick", V_UI_ACTION, uiNode_t, onClick);
/* Called when the user click with right button into the node. */
UI_RegisterNodeProperty(behaviour, "onrclick", V_UI_ACTION, uiNode_t, onRightClick);
/* Called when the user click with middle button into the node. */
UI_RegisterNodeProperty(behaviour, "onmclick", V_UI_ACTION, uiNode_t, onMiddleClick);
/* Called when the user use the mouse wheel over the node. */
UI_RegisterNodeProperty(behaviour, "onwheel", V_UI_ACTION, uiNode_t, onWheel);
/* Called when the user use the mouse wheel up over the node. */
UI_RegisterNodeProperty(behaviour, "onwheelup", V_UI_ACTION, uiNode_t, onWheelUp);
/* Called when the user use the mouse wheel down over the node. */
UI_RegisterNodeProperty(behaviour, "onwheeldown", V_UI_ACTION, uiNode_t, onWheelDown);
/* Called when the mouse enter over the node. */
UI_RegisterNodeProperty(behaviour, "onmouseenter", V_UI_ACTION, uiNode_t, onMouseEnter);
/* Called when the mouse go out of the node. */
UI_RegisterNodeProperty(behaviour, "onmouseleave", V_UI_ACTION, uiNode_t, onMouseLeave);
/* Called when the internal content of the nde change. Each behaviour use it how they need it.
* @todo Move it where it is need.
*/
UI_RegisterNodeProperty(behaviour, "onchange", V_UI_ACTION, uiNode_t, onChange);
/* Special attribute only use into the node description to exclude part of the node
* (see also <code>ghost</code>). Rectangle position is relative to the node. */
UI_RegisterNodeProperty(behaviour, "excluderect", V_UI_EXCLUDERECT, uiNode_t, firstExcludeRect);
/* Remove all child from the node (only dynamic allocated nodes). */
UI_RegisterNodeMethod(behaviour, "removeallchild", UI_AbstractNodeCallRemovaAllChild);
/* Create a new child with name and type. */
UI_RegisterNodeMethod(behaviour, "createchild", UI_AbstractNodeCallCreateChild);
/* Delete the node and remove it from his parent. */
UI_RegisterNodeMethod(behaviour, "delete", UI_AbstractNodeCallDelete);
/* Delete the node in x ms and remove it from his parent. */
UI_RegisterNodeMethod(behaviour, "deletetimed", UI_AbstractNodeCallDeleteTimed);
/** @todo move it into common? */
Com_RegisterConstInt("ALIGN_UL", ALIGN_UL);
Com_RegisterConstInt("ALIGN_UC", ALIGN_UC);
Com_RegisterConstInt("ALIGN_UR", ALIGN_UR);
Com_RegisterConstInt("ALIGN_CL", ALIGN_CL);
Com_RegisterConstInt("ALIGN_CC", ALIGN_CC);
Com_RegisterConstInt("ALIGN_CR", ALIGN_CR);
Com_RegisterConstInt("ALIGN_LL", ALIGN_LL);
Com_RegisterConstInt("ALIGN_LC", ALIGN_LC);
Com_RegisterConstInt("ALIGN_LR", ALIGN_LR);
/* some commands */
#ifdef DEBUG
Cmd_AddCommand("debug_mnsetnodeproperty", UI_NodeSetProperty_f, "Set a node property");
Cmd_AddCommand("debug_mngetnodeproperty", UI_NodeGetProperty_f, "Get a node property");
#endif
}
