node Directory Reference

src/client/ui/node/

Files

file  ui_node_abstractnode.c [code]
 

Every node extends this node.


file  ui_node_abstractnode.h [code]
file  ui_node_abstractoption.c [code]
file  ui_node_abstractoption.h [code]
file  ui_node_abstractscrollable.c [code]
file  ui_node_abstractscrollable.h [code]
 

base code for scrollable node


file  ui_node_abstractscrollbar.c [code]
 

The abstractscrollbar is an abstract node (we can't instantiate it). It exists to share same properties for vertical and horizontal scrollbar. At the moment only the concrete vscrollbar.


file  ui_node_abstractscrollbar.h [code]
file  ui_node_abstractvalue.c [code]
 

The abstractvalue node is an abstract node (we can't instanciate it). It provide common properties to concrete nodes, to manage a value in a range.


file  ui_node_abstractvalue.h [code]
 

Define common thing for GUI controls which allow to edit a value (scroolbar, spinner, and more).


file  ui_node_bar.c [code]
 

The bar node display a graphical horizontal slider. We can use it to allow the user to select a value in a range. Or we can use it do only display a value (in this case, you must disable it).


file  ui_node_bar.h [code]
file  ui_node_base.c [code]
file  ui_node_base.h [code]
file  ui_node_baseinventory.c [code]
 

The container node refer to 3 different nodes merged into a singler one. Both can drag and drop solider items from a container to another one. The first container is a soldier slot. For example, the left arm, the bag pack... The second is the base item list. And the last it a floor container used into the battlescape. The node name itself is used to know the container role.


file  ui_node_baseinventory.h [code]
file  ui_node_button.c [code]
 

button is a node to define a button with a random size. It is skinned with a special image template (see the image property).


file  ui_node_button.h [code]
file  ui_node_checkbox.c [code]
 

The checkbox node is a three state widget. If the value is 0, checkbox is unchecked, if value is bigger than 0, the value is checked; but if the value is under 0, the checkbox display an "invalidate" status.


file  ui_node_checkbox.h [code]
file  ui_node_container.c [code]
 

The container node refer to 3 different nodes merged into a singler one. Both can drag and drop solider items from a container to another one. The first container is a soldier slot. For example, the left arm, the bag pack... The second is the base item list. And the last it a floor container used into the battlescape. The node name itself is used to know the container role.


file  ui_node_container.h [code]
file  ui_node_controls.c [code]
 

Controls is a special pic entity with which the windows can be moved (drag & drop).


file  ui_node_controls.h [code]
file  ui_node_custombutton.c [code]
 

Custombutton is a button using a skin with a fixed size. We can define every pixels into the texture. It can't be bigger than 256x64, because each row of 64 pixels are used for the button status (normal, hovered, disabled, and the last is not used).


file  ui_node_custombutton.h [code]
file  ui_node_editor.c [code]
 

Editor is an invisible node used to create an edition mode. The edition mode allow user to move and resize all visible nodes.


file  ui_node_editor.h [code]
file  ui_node_ekg.c [code]
 

Health and morale ekg images for actors.


file  ui_node_ekg.h [code]
file  ui_node_image.c [code]
 

The pic behaviour allow to draw an image or a part of an image into the GUI. It provide some layout properties. We can use it like an active node (mouse in/out/click...) but in this case, it is better to use nodes with a semantics (like button, or checkbox).


file  ui_node_image.h [code]
file  ui_node_item.c [code]
 

An item is only a model node allowing to display soldier armour. Soldier armour is an image, not a model.


file  ui_node_item.h [code]
file  ui_node_keybinding.c [code]
 

This node implements the key binding change and display.


file  ui_node_keybinding.h [code]
file  ui_node_linechart.c [code]
file  ui_node_linechart.h [code]
file  ui_node_map.c [code]
file  ui_node_map.h [code]
file  ui_node_material_editor.c [code]
 

Material editor related code.


file  ui_node_material_editor.h [code]
 

Material editor related header.


file  ui_node_messagelist.c [code]
file  ui_node_messagelist.h [code]
file  ui_node_model.c [code]
 

This node allow to include a 3D-model into the GUI. It provide a way to create composite models, check [[How to script UI::How to create a composite model]]. We call it "main model" when a model is a child node of a non model node, and "submodel" when the node is a child node of a model node.


file  ui_node_model.h [code]
file  ui_node_option.c [code]
file  ui_node_option.h [code]
file  ui_node_optionlist.c [code]
file  ui_node_optionlist.h [code]
file  ui_node_optiontree.c [code]
file  ui_node_optiontree.h [code]
file  ui_node_panel.c [code]
file  ui_node_panel.h [code]
file  ui_node_radar.c [code]
file  ui_node_radar.h [code]
file  ui_node_radiobutton.c [code]
 

The radiobutton is a clickable widget. Commonly, with use it in a group of radiobuttons; the user is allowed to choose only one button from this set. The current implementation share the value of the group with a cvar, and each button use is own value. When the cvar equals to a button value, this button is selected.


file  ui_node_radiobutton.h [code]
file  ui_node_rows.c [code]
file  ui_node_rows.h [code]
file  ui_node_selectbox.c [code]
file  ui_node_selectbox.h [code]
file  ui_node_sequence.c [code]
file  ui_node_sequence.h [code]
file  ui_node_special.c [code]
 

The zone node allow to create an hidden active node. Currently we only use it to support repeat mouse actions without merging the code which managing this feature.


file  ui_node_special.h [code]
file  ui_node_spinner.c [code]
 

The spinner node is a vertical widget used to change a value.


file  ui_node_spinner.h [code]
file  ui_node_string.c [code]
 

A string can be a normal string, or a cvar string. A string prefixed with a "_" is the auto translated.


file  ui_node_string.h [code]
file  ui_node_tab.c [code]
file  ui_node_tab.h [code]
file  ui_node_tbar.c [code]
file  ui_node_tbar.h [code]
file  ui_node_text.c [code]
file  ui_node_text.h [code]
file  ui_node_text2.c [code]
file  ui_node_text2.h [code]
file  ui_node_textentry.c [code]
 

This node allow to edit a cvar text with the keyboard. When we click on the node, we active the edition, we can validate it with the ''RETURN'' key, or abort it with ''ESCAPE'' key. A validation fire a scriptable callback event. We can custom the mouse behaviour when we click outside the node in edition mode. It can validate or abort the edition.


file  ui_node_textentry.h [code]
file  ui_node_textlist.c [code]
file  ui_node_textlist.h [code]
file  ui_node_todo.c [code]
 

A node allowing to tag a GUI with comment (only visible on debug mode).


file  ui_node_todo.h [code]
file  ui_node_video.c [code]
file  ui_node_video.h [code]
file  ui_node_vscrollbar.c [code]
file  ui_node_vscrollbar.h [code]
file  ui_node_window.c [code]
file  ui_node_window.h [code]
file  ui_node_zone.c [code]
file  ui_node_zone.h [code]

Generated by  doxygen 1.6.2