orx  stable
Portable Game Engine
orxConsole.h
Go to the documentation of this file.
1 /* Orx - Portable Game Engine
2  *
3  * Copyright (c) 2008-2017 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 
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 "-=ConsoleSet=-"
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_SCROLL_DOWN "ScrollDown"
66 #define orxCONSOLE_KZ_INPUT_SCROLL_UP "ScrollUp"
71 extern orxDLLAPI void orxFASTCALL orxConsole_Setup();
72 
76 extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Init();
77 
80 extern orxDLLAPI void orxFASTCALL orxConsole_Exit();
81 
82 
86 extern orxDLLAPI void orxFASTCALL orxConsole_Enable(orxBOOL _bEnable);
87 
91 extern orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsEnabled();
92 
93 
97 extern orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsInsertMode();
98 
99 
106 extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetToggle(orxINPUT_TYPE _eInputType, orxENUM _eInputID, orxINPUT_MODE _eInputMode);
107 
108 
113 extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Log(const orxSTRING _zText);
114 
115 
120 extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetFont(const orxFONT *_pstFont);
121 
125 extern orxDLLAPI const orxFONT *orxFASTCALL orxConsole_GetFont();
126 
127 
132 extern orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetLogLineLength(orxU32 _u32LineLength);
133 
137 extern orxDLLAPI orxU32 orxFASTCALL orxConsole_GetLogLineLength();
138 
139 
144 extern orxDLLAPI orxU32 orxFASTCALL orxConsole_GetCompletionCounter(orxU32 *_pu32MaxLength);
145 
151 extern orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetCompletion(orxU32 _u32Index, orxBOOL *_pbActive);
152 
153 
158 extern orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetTrailLogLine(orxU32 _u32TrailLineIndex);
159 
163 extern orxDLLAPI orxU32 orxFASTCALL orxConsole_GetTrailLogLineOffset();
164 
169 extern orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetInput(orxU32 *_pu32CursorIndex);
170 
171 
172 #endif /* _orxCONSOLE_H_ */
173 
orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsEnabled()
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetToggle(orxINPUT_TYPE _eInputType, orxENUM _eInputID, orxINPUT_MODE _eInputMode)
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetLogLineLength(orxU32 _u32LineLength)
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Log(const orxSTRING _zText)
orxDLLAPI orxBOOL orxFASTCALL orxConsole_IsInsertMode()
orxDLLAPI void orxFASTCALL orxConsole_Exit()
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_Init()
orxDLLAPI orxU32 orxFASTCALL orxConsole_GetTrailLogLineOffset()
orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetInput(orxU32 *_pu32CursorIndex)
orxINPUT_MODE
Definition: orxInput.h:83
orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetCompletion(orxU32 _u32Index, orxBOOL *_pbActive)
orxDLLAPI void orxFASTCALL orxConsole_Enable(orxBOOL _bEnable)
orxDLLAPI const orxFONT *orxFASTCALL orxConsole_GetFont()
orxDLLAPI orxU32 orxFASTCALL orxConsole_GetLogLineLength()
orxSTATUS
Definition: orxType.h:243
orxDLLAPI orxSTATUS orxFASTCALL orxConsole_SetFont(const orxFONT *_pstFont)
orxDLLAPI const orxSTRING orxFASTCALL orxConsole_GetTrailLogLine(orxU32 _u32TrailLineIndex)
#define orxDLLAPI
Definition: orxDecl.h:387
orxINPUT_TYPE
Definition: orxInput.h:66
orxDLLAPI orxU32 orxFASTCALL orxConsole_GetCompletionCounter(orxU32 *_pu32MaxLength)
struct __orxFONT_t orxFONT
Definition: orxFont.h:58

Generated for orx by doxygen 1.5.6