A console, that displays logger messages, and where the user can enter commands. More...

#include <geogram_gfx/gui/console.h>

Inheritance diagram for GEO::Console:

Public Types
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)

Public Member Functions
	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.

virtual void	draw (bool *visible=nullptr, bool with_window=true)
	Draws the console and handles the gui.

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
virtual void	notify_error (const std::string &err)
	This function is called whenever an error is displayed using err()

virtual bool	exec_command (const char *command)

virtual void	update ()
	Redraws the GUI.

Protected Attributes
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, that displays logger messages, and where the user can enter commands.

Inspired from ImGui AppLog example.

Definition at line 59 of file console.h.

Member Typedef Documentation

◆ CompletionCallback

typedef void(* GEO::Console::CompletionCallback) (Console *console, const std::string &line, index_t startw, index_t endw, const std::string &cmpword, std::vector< std::string > &matches)

Definition at line 125 of file console.h.

◆ HistoryCallback

typedef void(* GEO::Console::HistoryCallback) (Console *console, index_t index, std::string &command)

Definition at line 135 of file console.h.

Constructor & Destructor Documentation

◆ Console()

GEO::Console::Console ( bool * visible_flag = nullptr )

Console constructor.

Parameters

[in] visible_flag an optional pointer to application's variable that controls the visibility of this Console.

Member Function Documentation

◆ div()

void GEO::Console::div ( const std::string & value )

override

◆ draw()

virtual void GEO::Console::draw	(	bool *	visible = `nullptr`,
		bool	with_window = `true`
	)

virtual

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 in OGF::Console.

◆ err()

void GEO::Console::err ( const std::string & value )

override

◆ exec_command()

virtual bool GEO::Console::exec_command ( const char * command )

protectedvirtual

Reimplemented in OGF::Console.

◆ hide()

void GEO::Console::hide ( )

inline

Definition at line 121 of file console.h.

◆ hide_command_prompt()

void GEO::Console::hide_command_prompt ( )

inline

Definition at line 156 of file console.h.

◆ notify_error()

virtual void GEO::Console::notify_error ( const std::string & err )

protectedvirtual

This function is called whenever an error is displayed using err()

Base implementation does nothing. This function is meant to be overloaded in derived classes.

Parameters

[in] err the error message sent to err()

Reimplemented in OGF::Console.

◆ out()

void GEO::Console::out ( const std::string & value )

override

◆ set_completion_callback()

void GEO::Console::set_completion_callback ( CompletionCallback CB )

inline

Definition at line 131 of file console.h.

◆ set_history_callback()

void GEO::Console::set_history_callback ( HistoryCallback CB )

inline

Definition at line 141 of file console.h.

◆ set_history_size()

void GEO::Console::set_history_size ( index_t n )

inline

Definition at line 145 of file console.h.

◆ show()

void GEO::Console::show ( )

inline

Definition at line 117 of file console.h.

◆ show_command_prompt()

void GEO::Console::show_command_prompt ( )

inline

Definition at line 152 of file console.h.

◆ status()

void GEO::Console::status ( const std::string & value )

override

◆ update()

virtual void GEO::Console::update ( )

protectedvirtual

Redraws the GUI.

Reimplemented in OGF::Console.

◆ warn()

void GEO::Console::warn ( const std::string & value )

override

Member Data Documentation

◆ buf_

ImGuiTextBuffer GEO::Console::buf_

protected

Definition at line 178 of file console.h.

◆ command_prompt_

bool GEO::Console::command_prompt_

protected

Definition at line 177 of file console.h.

◆ completion_callback_

CompletionCallback GEO::Console::completion_callback_

protected

Definition at line 185 of file console.h.

◆ filter_

ImGuiTextFilter GEO::Console::filter_

protected

Definition at line 179 of file console.h.

◆ history_callback_

HistoryCallback GEO::Console::history_callback_

protected

Definition at line 186 of file console.h.

◆ history_index_

index_t GEO::Console::history_index_

protected

Definition at line 187 of file console.h.

◆ input_buf_

char GEO::Console::input_buf_[geo_imgui_string_length]

protected

Definition at line 184 of file console.h.

◆ line_offsets_

ImVector<int> GEO::Console::line_offsets_

protected

Index to lines offset.

Definition at line 181 of file console.h.

◆ max_history_index_

index_t GEO::Console::max_history_index_

protected

Definition at line 188 of file console.h.

◆ scroll_to_bottom_

index_t GEO::Console::scroll_to_bottom_

protected

Definition at line 182 of file console.h.

◆ visible_flag_

bool* GEO::Console::visible_flag_

protected

Definition at line 183 of file console.h.

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

geogram_gfx/gui/console.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CompletionCallback

◆ HistoryCallback

Constructor & Destructor Documentation

◆ Console()

Member Function Documentation

◆ div()

◆ draw()

◆ err()

◆ exec_command()

◆ hide()

◆ hide_command_prompt()

◆ notify_error()

◆ out()

◆ set_completion_callback()

◆ set_history_callback()

◆ set_history_size()

◆ show()

◆ show_command_prompt()

◆ status()

◆ update()

◆ warn()

Member Data Documentation

◆ buf_

◆ command_prompt_

◆ completion_callback_

◆ filter_

◆ history_callback_

◆ history_index_

◆ input_buf_

◆ line_offsets_

◆ max_history_index_

◆ scroll_to_bottom_

◆ visible_flag_