orxConsole.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2022 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxCONSOLE_H_
#define _orxCONSOLE_H_


#include "orxInclude.h"
#include "display/orxFont.h"
#include "io/orxInput.h"


#define orxCONSOLE_KZ_INPUT_SET                       "-=ConsoleSet=-"                
#define orxCONSOLE_KZ_INPUT_TOGGLE                    "Toggle"                        
#define orxCONSOLE_KZ_INPUT_AUTOCOMPLETE              "AutoComplete"                  
#define orxCONSOLE_KZ_INPUT_DELETE                    "Delete"                        
#define orxCONSOLE_KZ_INPUT_DELETE_AFTER              "DeleteAfter"                   
#define orxCONSOLE_KZ_INPUT_TOGGLE_MODE               "ToggleMode"                    
#define orxCONSOLE_KZ_INPUT_ENTER                     "Enter"                         
#define orxCONSOLE_KZ_INPUT_PREVIOUS                  "Previous"                      
#define orxCONSOLE_KZ_INPUT_NEXT                      "Next"                          
#define orxCONSOLE_KZ_INPUT_LEFT                      "Left"                          
#define orxCONSOLE_KZ_INPUT_RIGHT                     "Right"                         
#define orxCONSOLE_KZ_INPUT_START                     "Start"                         
#define orxCONSOLE_KZ_INPUT_END                       "End"                           
#define orxCONSOLE_KZ_INPUT_PASTE                     "Paste"                         
#define orxCONSOLE_KZ_INPUT_SCROLL_DOWN               "ScrollDown"                    
#define orxCONSOLE_KZ_INPUT_SCROLL_UP                 "ScrollUp"                      
#define orxCONSOLE_KZ_CONFIG_HISTORY_FILE_EXTENSION   "cih"                           
extern orxDLLAPI void orxFASTCALL                     orxConsole_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                orxConsole_Init();

extern orxDLLAPI void orxFASTCALL                     orxConsole_Exit();


extern orxDLLAPI void orxFASTCALL                     orxConsole_Enable(orxBOOL _bEnable);

extern orxDLLAPI orxBOOL orxFASTCALL                  orxConsole_IsEnabled();


extern orxDLLAPI orxBOOL orxFASTCALL                  orxConsole_IsInsertMode();


extern orxDLLAPI orxSTATUS orxFASTCALL                orxConsole_SetToggle(orxINPUT_TYPE _eInputType, orxENUM _eInputID, orxINPUT_MODE _eInputMode);


extern orxDLLAPI orxSTATUS orxFASTCALL                orxConsole_Log(const orxSTRING _zText);


extern orxDLLAPI orxSTATUS orxFASTCALL                orxConsole_SetFont(const orxFONT *_pstFont);

extern orxDLLAPI const orxFONT *orxFASTCALL           orxConsole_GetFont();


extern orxDLLAPI orxSTATUS orxFASTCALL                orxConsole_SetLogLineLength(orxU32 _u32LineLength);

extern orxDLLAPI orxU32 orxFASTCALL                   orxConsole_GetLogLineLength();


extern orxDLLAPI orxU32 orxFASTCALL                   orxConsole_GetCompletionCount(orxU32 *_pu32MaxLength);

extern orxDLLAPI const orxSTRING orxFASTCALL          orxConsole_GetCompletion(orxU32 _u32Index, orxBOOL *_pbActive);


extern orxDLLAPI const orxSTRING orxFASTCALL          orxConsole_GetTrailLogLine(orxU32 _u32TrailLineIndex);

extern orxDLLAPI orxU32 orxFASTCALL                   orxConsole_GetTrailLogLineOffset();

extern orxDLLAPI const orxSTRING orxFASTCALL          orxConsole_GetInput(orxU32 *_pu32CursorIndex);


#endif /* _orxCONSOLE_H_ */