ui_popup.h File Reference

#include "node/ui_node_text.h"

Go to the source code of this file.

Macros
#define	POPUPLIST_WINDOW_NAME   "popup_list"
#define	POPUPLIST_NODE_NAME   "popup_list"
#define	UI_MAX_SMALLTEXTLEN   1024

Functions
void	UI_Popup (const char *title, const char *text)
	Popup on geoscape. More...
uiNode_t *	UI_PopupList (const char *title, const char *headline, linkedList_t *entries, const char *clickAction)
	Generates a popup that contains a list of selectable choices. More...
void	UI_PopupButton (const char *title, const char *text, const char *clickAction1, const char *clickText1, const char *tooltip1, const char *clickAction2, const char *clickText2, const char *tooltip2, const char *clickAction3, const char *clickText3, const char *tooltip3)
	Generates a popup that contains up to 3 buttons. More...

Variables
char	popupText [UI_MAX_SMALLTEXTLEN]
	strings to be used for popup when text is not static More...

Macro Definition Documentation

#define POPUPLIST_NODE_NAME   "popup_list"

Definition at line 30 of file ui_popup.h.

Referenced by HUD_UpdateButtons(), and UI_PopupList().

#define POPUPLIST_WINDOW_NAME   "popup_list"

Definition at line 29 of file ui_popup.h.

Referenced by UI_PopupList().

#define UI_MAX_SMALLTEXTLEN   1024

Todo:

we should delete it, UI script support random text size

Definition at line 34 of file ui_popup.h.

Referenced by HUD_MapDebugCursor(), HUD_UpdateActorFireMode(), HUD_UpdateActorMove(), and INV_ItemDescription().

Function Documentation

void UI_Popup	(	const char *	title,
		const char *	text
	)

Popup on geoscape.

Note

Only use static strings here - or use popupText if you really have to build the string

Definition at line 47 of file ui_popup.cpp.

References Cvar_Set(), POPUP_WINDOW_NAME, TEXT_POPUP_INFO, UI_IsWindowOnStack(), UI_PushWindow(), and UI_RegisterText().

Referenced by CL_ActorInvMove(), CL_CanMultiplayerStart(), CL_ConnectionlessPacket(), GAME_SaveTeam_f(), GAME_UI_Popup(), HUD_UpdateActorLoad_f(), INV_MoveItem(), INV_UpdateActorLoad_f(), Irc_Logic_ReadMessages(), Irc_Proto_ProcessServerMsg(), and UI_Popup_f().

void UI_PopupButton	(	const char *	title,
		const char *	text,
		const char *	clickAction1,
		const char *	clickText1,
		const char *	tooltip1,
		const char *	clickAction2,
		const char *	clickText2,
		const char *	tooltip2,
		const char *	clickAction3,
		const char *	clickText3,
		const char *	tooltip3
	)

Generates a popup that contains up to 3 buttons.

Parameters

[in]	title	Title of the popup.
[in]	text	Text to display in the popup (use popupText if text is nullptr).
[in]	clickAction1	Action to perform when one clicked on the first button.
[in]	clickText1	String that will be written in first button.
[in]	tooltip1	Tooltip of first button.
[in]	clickAction2	Action to perform when one clicked on the second button.
[in]	clickText2	String that will be written in second button.
[in]	tooltip2	Tooltip of second button.
[in]	clickAction3	Action to perform when one clicked on the third button.
[in]	clickText3	String that will be written in third button.
[in]	tooltip3	Tooltip of third button.

Note

clickAction AND clickText must be nullptr if button should be invisible.

Definition at line 147 of file ui_popup.cpp.

References Com_Error(), Cvar_Set(), ERR_FATAL, uiNode_t::name, popupAction1, popupAction2, popupAction3, POPUPBUTTON_NODE_NAME, POPUPBUTTON_WINDOW_NAME, popupText, TEXT_POPUP_INFO, UI_GetWindow(), UI_IsWindowOnStack(), UI_PushWindow(), UI_RegisterText(), UI_SetOneButton(), and va().

Referenced by GAME_GetImportData().

uiNode_t* UI_PopupList	(	const char *	title,
		const char *	headline,
		linkedList_t *	entries,
		const char *	clickAction
	)

Generates a popup that contains a list of selectable choices.

Parameters

[in]	title	Title of the popup.
[in]	headline	First line of text written in the popup.
[in]	entries	List of the selectables choices.
[in]	clickAction	Action to perform when one clicked on the popup.

Definition at line 62 of file ui_popup.cpp.

References Com_Error(), Cvar_Set(), uiAction_s::d, EA_CMD, ERR_FATAL, Mem_Free, uiNode_t::name, uiNode_t::onClick, POPUPLIST_NODE_NAME, POPUPLIST_WINDOW_NAME, uiAction_s::terminal, TEXT_LIST, TEXT_POPUP_INFO, UI_GetNode(), UI_GetWindow(), UI_IsWindowOnStack(), UI_PoolAllocAction(), UI_PushWindow(), UI_RegisterLinkedListText(), UI_RegisterText(), and UI_ResetData().

Referenced by GAME_GetImportData(), and HUD_PopupFiremodeReservation().

Variable Documentation

char popupText[UI_MAX_SMALLTEXTLEN]

strings to be used for popup when text is not static

Definition at line 37 of file ui_popup.cpp.

Referenced by CL_CanMultiplayerStart(), CL_ConnectionlessPacket(), CP_BaseAttackPrepareBattle(), GAME_UI_Popup(), HUD_UpdateActorLoad_f(), INV_UpdateActorLoad_f(), Irc_Proto_ProcessServerMsg(), and UI_PopupButton().