orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
orxConsole.h
Go to the documentation of this file.
1/* Orx - Portable Game Engine
2 *
3 * Copyright (c) 2008- Orx-Project
4 *
5 * This software is provided 'as-is', without any express or implied
6 * warranty. In no event will the authors be held liable for any damages
7 * arising from the use of this software.
8 *
9 * Permission is granted to anyone to use this software for any purpose,
10 * including commercial applications, and to alter it and redistribute it
11 * freely, subject to the following restrictions:
12 *
13 * 1. The origin of this software must not be misrepresented; you must not
14 * claim that you wrote the original software. If you use this software
15 * in a product, an acknowledgment in the product documentation would be
16 * appreciated but is not required.
17 *
18 * 2. Altered source versions must be plainly marked as such, and must not be
19 * misrepresented as being the original software.
20 *
21 * 3. This notice may not be removed or altered from any source
22 * distribution.
23 */
24
31
39
40#ifndef _orxCONSOLE_H_
41#define _orxCONSOLE_H_
42
43
44#include "orxInclude.h"
45#include "display/orxFont.h"
46#include "io/orxInput.h"
47
48
51#define orxCONSOLE_KZ_INPUT_SET "orx:input:console"
52
53#define orxCONSOLE_KZ_INPUT_TOGGLE "Toggle"
54#define orxCONSOLE_KZ_INPUT_AUTOCOMPLETE "AutoComplete"
55#define orxCONSOLE_KZ_INPUT_DELETE "Delete"
56#define orxCONSOLE_KZ_INPUT_DELETE_AFTER "DeleteAfter"
57#define orxCONSOLE_KZ_INPUT_TOGGLE_MODE "ToggleMode"
58#define orxCONSOLE_KZ_INPUT_ENTER "Enter"
59#define orxCONSOLE_KZ_INPUT_PREVIOUS "Previous"
60#define orxCONSOLE_KZ_INPUT_NEXT "Next"
61#define orxCONSOLE_KZ_INPUT_LEFT "Left"
62#define orxCONSOLE_KZ_INPUT_RIGHT "Right"
63#define orxCONSOLE_KZ_INPUT_START "Start"
64#define orxCONSOLE_KZ_INPUT_END "End"
65#define orxCONSOLE_KZ_INPUT_PASTE "Paste"
66#define orxCONSOLE_KZ_INPUT_SCROLL_DOWN "ScrollDown"
67#define orxCONSOLE_KZ_INPUT_SCROLL_UP "ScrollUp"
68
69#define orxCONSOLE_KZ_CONFIG_HISTORY_FILE_EXTENSION "cih"
70
71
74extern orxDLLAPI void orxFASTCALL orxConsole_Setup();
75
79extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Init();
80
83extern orxDLLAPI void orxFASTCALL orxConsole_Exit();
84
85
89extern orxDLLAPI void orxFASTCALL orxConsole_Enable(orxBOOL _bEnable);
90
94extern orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsEnabled();
95
96
100extern orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsInsertMode();
101
102
109extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetToggle(orxINPUT_TYPE _eInputType, orxENUM _eInputID, orxINPUT_MODE _eInputMode);
110
111
116extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Log(const orxSTRING _zText);
117
118
123extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetFont(const orxFONT *_pstFont);
124
128extern orxDLLAPI const orxFONT *orxFASTCALL orxConsole_GetFont();
129
130
135extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetLogLineLength(orxU32 _u32LineLength);
136
140extern orxDLLAPI orxU32 orxFASTCALL orxConsole_GetLogLineLength();
141
142
147extern orxDLLAPI orxU32 orxFASTCALL orxConsole_GetCompletionCount(orxU32 *_pu32MaxLength);
148
154extern orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetCompletion(orxU32 _u32Index, orxBOOL *_pbActive);
155
156
161extern orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetTrailLogLine(orxU32 _u32TrailLineIndex);
162
166extern orxDLLAPI orxU32 orxFASTCALL orxConsole_GetTrailLogLineOffset();
167
172extern orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetInput(orxU32 *_pu32CursorIndex);
173
174
175#endif /* _orxCONSOLE_H_ */
176
orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetCompletion(orxU32 _u32Index, orxBOOL *_pbActive)
orxDLLAPI orxU32 orxFASTCALL orxConsole_GetLogLineLength()
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetFont(const orxFONT *_pstFont)
orxDLLAPI void orxFASTCALL orxConsole_Exit()
orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsEnabled()
orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsInsertMode()
orxDLLAPI const orxFONT *orxFASTCALL orxConsole_GetFont()
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Init()
orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetTrailLogLine(orxU32 _u32TrailLineIndex)
orxDLLAPI void orxFASTCALL orxConsole_Setup()
orxDLLAPI orxU32 orxFASTCALL orxConsole_GetTrailLogLineOffset()
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetToggle(orxINPUT_TYPE _eInputType, orxENUM _eInputID, orxINPUT_MODE _eInputMode)
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetLogLineLength(orxU32 _u32LineLength)
orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetInput(orxU32 *_pu32CursorIndex)
orxDLLAPI void orxFASTCALL orxConsole_Enable(orxBOOL _bEnable)
orxDLLAPI orxU32 orxFASTCALL orxConsole_GetCompletionCount(orxU32 *_pu32MaxLength)
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Log(const orxSTRING _zText)
#define orxDLLAPI
Definition orxDecl.h:381
orxINPUT_TYPE
Definition orxInput.h:77
orxINPUT_MODE
Definition orxInput.h:94
#define orxFONT(STRUCTURE)
orxSTATUS
Definition orxType.h:270

Generated for orx by doxygen 1.8.11