User Interface Macros: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Dialog_Control#" to "[[Arma: GUI Configuration#")
m (Text replacement - "\{\{ *codecomment *\| *\/\/ *([^ ]+) *\}\} " to "{{cc|$1}}")
Line 8: Line 8:
DIK codes of every keyboard key. Useful for [[User Interface Event Handlers]] and button shortcuts.
DIK codes of every keyboard key. Useful for [[User Interface Event Handlers]] and button shortcuts.
=== Sample code ===
=== Sample code ===
  shortcuts[] = {INPUT_CTRL_OFFSET + DIK_P}; {{codecomment|//--- Button is activated when Ctrl+S is pressed}}
  shortcuts[] = {INPUT_CTRL_OFFSET + DIK_P}; {{cc|--- Button is activated when Ctrl+S is pressed}}
 


== defineResincl.inc ==
== defineResincl.inc ==
Line 15: Line 14:
Latest defined [[Arma: GUI Configuration#Constants|constants]] for use in [[Display]] and [[Control]] classes. Amont others contains control types, colors, grids
Latest defined [[Arma: GUI Configuration#Constants|constants]] for use in [[Display]] and [[Control]] classes. Amont others contains control types, colors, grids
=== Sample code ===
=== Sample code ===
  style = ST_LEFT + ST_MULTI; {{codecomment|//--- Text in control can contain multiple lines and is alligned to left}}
  style = ST_LEFT + ST_MULTI; {{cc|--- Text in control can contain multiple lines and is alligned to left}}
 


== defineCommon.inc ==
== defineCommon.inc ==
Line 23: Line 21:
Game specific [[User Interface Grids|grids]], [[User Interface Colors|colors]], text sizes etc.
Game specific [[User Interface Grids|grids]], [[User Interface Colors|colors]], text sizes etc.
=== Sample code ===
=== Sample code ===
  {{codecomment|//--- Control position alligned to defined grid}}
  {{cc|--- Control position alligned to defined grid}} x = 1 * GUI_GRID_W + GUI_GRID_X;
x = 1 * GUI_GRID_W + GUI_GRID_X;
  y = 18 * GUI_GRID_H + GUI_GRID_Y;
  y = 18 * GUI_GRID_H + GUI_GRID_Y;
  w = 10 * GUI_GRID_W;
  w = 10 * GUI_GRID_W;
Line 35: Line 32:
Basic [[Arma: GUI Configuration#Controls|parent classes]].
Basic [[Arma: GUI Configuration#Controls|parent classes]].
=== Sample code ===
=== Sample code ===
  {{codecomment|//--- Control inherited from RscText base class}}
  {{cc|--- Control inherited from RscText base class}} class textColorG: RscText
class textColorG: RscText
  {
  {
  };
  };

Revision as of 17:26, 29 January 2021

Take On Helicopters offers unbinarized user interface macros and parent classes for anybody who wants to include them in their Config.cpp or Description.ext.

Knowledge of PreProcessor Commands is required for use.

defineDIKCodes.inc

#include "\hsim\UI_H\hpp\defineDIKCodes.inc"

DIK codes of every keyboard key. Useful for User Interface Event Handlers and button shortcuts.

Sample code

shortcuts[] = {INPUT_CTRL_OFFSET + DIK_P}; // --- Button is activated when Ctrl+S is pressed

defineResincl.inc

#include "\hsim\UI_H\hpp\defineResincl.inc"

Latest defined constants for use in Display and Control classes. Amont others contains control types, colors, grids

Sample code

style = ST_LEFT + ST_MULTI; // --- Text in control can contain multiple lines and is alligned to left

defineCommon.inc

Requires defineResincl.inc

#include "\hsim\UI_H\hpp\defineCommon.inc"

Game specific grids, colors, text sizes etc.

Sample code

// --- Control position alligned to defined grid x = 1 * GUI_GRID_W + GUI_GRID_X;
y = 18 * GUI_GRID_H + GUI_GRID_Y;
w = 10 * GUI_GRID_W;
h = 1 * GUI_GRID_H;


rscCommon.inc

Requires defineResincl.inc and defineCommon.inc

#include "\hsim\UI_H\hpp\rscCommon.inc"

Basic parent classes.

Sample code

// --- Control inherited from RscText base class class textColorG: RscText
{
};