A TextEditor for writing LUA functions. More...

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

Inheritance diagram for OGF::TextEditor:

Public Member Functions
	TextEditor (Interpreter *interpreter)
	TextEditor constructor.

	~TextEditor () override
	TextEditor destructor.

::TextEditor *	impl ()
	Gets the implementation.

Interpreter *	interpreter ()
	Gets the Interpreter.

std::vector< std::string > &	completions ()
	Gets the current list of completions.

std::string	get_text () const
	Gets the text.

std::string	get_selection () const
	Gets the selected text.

void	set_language (const std::string &language)
	Sets the language used for syntax highlighting.

const std::string &	get_language () const
	Gets the language used for syntax highlighting.

void	draw (const std::string &title)
	Draws the editor.

void	load (const std::string &filename)
	Loads a file in the editor.

void	save (const std::string &filename)
	Saves the contents of the editor into a file.

void	add_error_marker (index_t line, const std::string &error_message)

void	clear_error_markers ()

void	add_breakpoint (index_t line)

void	clear_breakpoints ()

void	find (const std::string &s)

void	cursor_forward ()

void	save_request ()
	Invoked when <F2> is pressed.

void	find_request ()
	Invoked when <Ctrl><F> is pressed.

void	stop_request ()
	Invoked when <Ctrl> `is pressed.`

void	tooltip_request (const std::string &context)
	Invoked when the cursor hovers over a word.

Public Member Functions inherited from OGF::Object
	Object (bool transient=false)
	Object constructor.

	~Object () override
	Object destructor.

virtual MetaClass *	meta_class () const
	Gets the meta class.

virtual void	set_meta_class (MetaClass *mclass)
	Sets the meta class.

unsigned int	id () const
	Gets the identifier of this object.

std::string	string_id () const
	Gets the unique string identifier.

bool	has_method (const std::string &method_name) const
	Tests whether a method is defined.

virtual bool	invoke_method (const std::string &method_name, const ArgList &args, Any &ret_val)
	Invokes a method by method name and argument list, and gets the return value.

bool	invoke_method (const std::string &method_name, const ArgList &args)
	Invokes a method by method name and argument list.

bool	invoke_method (const std::string &method_name)
	Invokes a method by method name.

bool	has_property (const std::string &prop_name) const
	Tests whether a property is defined.

virtual bool	get_property (const std::string &prop_name, std::string &prop_value) const
	Gets a property.

virtual Connection *	connect_signal_to_slot (const std::string &signal_name, Object *to, const std::string &slot_name)
	Connects a signal with a slot of another object.

virtual void	add_connection (Connection *connection)
	Adds a connection to this object.

virtual void	remove_connection (Connection *connection)
	Removes a connection to this object.

virtual void	get_element (index_t i, Any &value) const
	Gets an element by index.

virtual void	set_element (index_t i, const Any &value)
	Sets an element by index.

void	get_element (index_t item, index_t component, Any &value) const
	Gets an element by item and component.

void	set_element (index_t item, index_t component, const Any &value)
	Sets an element by item and component.

virtual void	search (const std::string &needle, const std::string &path="")
	Displays the names of all objects that contain a substring.

virtual index_t	get_dimension () const
	Gets the number of elements per item.

bool	get_signals_enabled () const
	Tests wheter signals are enabled.

void	set_signals_enabled (bool value)
	Enables or disables signals.

bool	get_slots_enabled () const
	Tests wheter slots are enabled.

void	set_slots_enabled (bool value)
	Enables or disables slots.

MetaClass *	get_meta_class () const
	Gets the meta class.

std::string	get_string_id () const
	Gets the unique string identifier.

virtual std::string	get_doc () const
	Gets the documentation.

virtual Sign	compare (const Object *other) const
	Compares this object with another one.

virtual bool	is_a (const MetaType *type) const
	Tests whether this object inherits a given type.

void	disconnect ()
	Removes all connections from signals of this objects.

void	enable_signals ()
	Enables signals.

void	disable_signals ()
	Disables signals.

void	enable_slots ()
	Enables slots.

void	disable_slots ()
	Disables slots.

void	set_properties (const ArgList &args)
	Sets several properties in a single call.

virtual bool	set_property (const std::string &name, const std::string &value)
	Sets an individual property.

void	help () const
	Displays some help about this object.

virtual bool	set_property (const std::string &name, const Any &value)
	Sets an individual property.

virtual bool	get_property (const std::string &prop_name, Any &prop_value) const
	Gets a property.

Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count.

void	unref () const
	Decrements the reference count.

bool	is_shared () const
	Check if the object is shared.

int	nb_refs () const
	Gets the number of references that point to this object.

Public Attributes
	: void set_text(const std::string& value)

	: void clear()

gom_signals	: void run_request()

Public Attributes inherited from OGF::Object
	: virtual index_t get_nb_elements() const

	: bool equals(const Object* other) const

Additional Inherited Members
Static Public Member Functions inherited from OGF::Object
static Object *	id_to_object (unsigned int id)
	Gets an object from a unique object id.

Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count.

static void	unref (const Counted *counted)
	Decrements the reference count.

Protected Member Functions inherited from OGF::Object
virtual bool	emit_signal (const std::string &signal_name, const ArgList &args, bool called_from_slot=false)
	Emits a signal and calls the slots it is connected to.

Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object.

virtual	~Counted ()
	Destroys a reference counted object.

Detailed Description

A TextEditor for writing LUA functions.

Definition at line 51 of file text_editor.h.

Member Function Documentation

◆ completions()

std::vector< std::string > & OGF::TextEditor::completions ( )

inline

Gets the current list of completions.

Returns: a reference to a vector with the list of completions.

Definition at line 84 of file text_editor.h.

◆ draw()

void OGF::TextEditor::draw ( const std::string & title )

Draws the editor.

Parameters

[in] title a unique ImGui ID used to identify this editor.

◆ get_selection()

std::string OGF::TextEditor::get_selection ( ) const

Gets the selected text.

Returns: a string with the selected text.

◆ get_text()

std::string OGF::TextEditor::get_text ( ) const

Gets the text.

Returns: a copy of the contents of the text buffer.

◆ impl()

::TextEditor * OGF::TextEditor::impl ( )

inline

Gets the implementation.

Returns: a pointer to the implementation.

Definition at line 67 of file text_editor.h.

◆ interpreter()

Interpreter * OGF::TextEditor::interpreter ( )

inline

Gets the Interpreter.

Returns: a pointer to the Interpreter.

Definition at line 75 of file text_editor.h.

◆ load()

void OGF::TextEditor::load ( const std::string & filename )

Loads a file in the editor.

Parameters

[in] filename the name of the file.

◆ save()

void OGF::TextEditor::save ( const std::string & filename )

Saves the contents of the editor into a file.

Parameters

[in] filename the name of the file.

◆ set_language()

void OGF::TextEditor::set_language ( const std::string & language )

Sets the language used for syntax highlighting.

Parameters

[in] language one of "lua","glsl","c","c++"

◆ tooltip_request()

void OGF::TextEditor::tooltip_request ( const std::string & context )

Invoked when the cursor hovers over a word.

Parameters

[in] context a string with the sourcecode element to be explained in the tooltip.

Member Data Documentation

◆ pad0

OGF::TextEditor::__pad0__

Definition at line 84 of file text_editor.h.

◆ pad1

OGF::TextEditor::__pad1__

Definition at line 117 of file text_editor.h.

◆ pad2

gom_signals OGF::TextEditor::__pad2__

Definition at line 156 of file text_editor.h.

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

OGF/skin_imgui/widgets/text_editor.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ completions()

◆ draw()

◆ get_selection()

◆ get_text()

◆ impl()

◆ interpreter()

◆ load()

◆ save()

◆ set_language()

◆ tooltip_request()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ __pad2__

◆ pad0

◆ pad1

◆ pad2