OGF::Console Class Reference

A console for Graphite. More...

#include <OGF/skin_imgui/widgets/console.h>

Inheritance diagram for OGF::Console:

Public Member Functions
	Console (Application *application)
	Console constructor.
Application *	application ()
	Gets the Application.
void	draw (bool *visible=nullptr, bool with_window=true) override
	Draws the console and handles the gui.
Public Member Functions inherited from GEO::Console
	Console (bool *visible_flag=nullptr)
	Console constructor.
void	div (const std::string &value) override
void	out (const std::string &value) override
void	warn (const std::string &value) override
void	err (const std::string &value) override
void	status (const std::string &value) override
void	clear ()
	Clears the contents of the console.
virtual void	printf (const char *fmt,...)
	Displays a formatted string to the console.
int	TextEditCallback (ImGuiInputTextCallbackData *data)
void	show ()
void	hide ()
void	set_completion_callback (CompletionCallback CB)
void	set_history_callback (HistoryCallback CB)
void	set_history_size (index_t n)
void	show_command_prompt ()
void	hide_command_prompt ()

Protected Member Functions
bool	exec_command (const char *command) override
void	update () override
void	notify_error (const std::string &err) override

Additional Inherited Members
Public Types inherited from GEO::Console
typedef void(*	CompletionCallback) (Console *console, const std::string &line, index_t startw, index_t endw, const std::string &cmpword, std::vector< std::string > &matches)
typedef void(*	HistoryCallback) (Console *console, index_t index, std::string &command)
Protected Attributes inherited from GEO::Console
bool	command_prompt_
ImGuiTextBuffer	buf_
ImGuiTextFilter	filter_
ImVector< int >	line_offsets_
	Index to lines offset.
index_t	scroll_to_bottom_
bool *	visible_flag_
char	input_buf_ [geo_imgui_string_length]
CompletionCallback	completion_callback_
HistoryCallback	history_callback_
index_t	history_index_
index_t	max_history_index_

Detailed Description

A console for Graphite.

Definition at line 50 of file console.h.

Constructor & Destructor Documentation

Console()

OGF::Console::Console

(

Application *

application

)

Console constructor.

Parameters

[in]

application

a pointer to the Application.

Member Function Documentation

application()

Application * OGF::Console::application ( )

inline

Gets the Application.

Returns

a pointer to the Application.

Definition at line 62 of file console.h.

draw()

void OGF::Console::draw ( bool *  visible = nullptr, bool  with_window = true  )

overridevirtual

Draws the console and handles the gui.

Parameters

[in]	visible	an optional pointer to a visibility flag, controlled by a close button if different from nullptr.
[in]	with_window	if true, then creates a new window using imgui::Begin() / imgui::End(), else caller is responsible for doing that.

Reimplemented from GEO::Console.

exec_command()

bool OGF::Console::exec_command ( const char *  command )

overrideprotectedvirtual

Reimplemented from GEO::Console.

notify_error()

void OGF::Console::notify_error ( const std::string &  err )

overrideprotectedvirtual

Reimplemented from GEO::Console.

update()

void OGF::Console::update ( )

overrideprotectedvirtual

Reimplemented from GEO::Console.

---

The documentation for this class was generated from the following file:

• OGF/skin_imgui/widgets/console.h