geometrize::dialog::CommandLineEdit Class Reference

The CommandLineEdit class models the UI for the command line in a graphical script console. More...

#include <commandlineedit.h>

Inheritance diagram for geometrize::dialog::CommandLineEdit:

Collaboration diagram for geometrize::dialog::CommandLineEdit:

Classes
class	CommandLineEditImpl

Signals
void	signal_commandSubmitted (const std::string &)
	signal_commandSubmitted is fired when a command is submitted by the user (e.g. after pressing return). More...
void	signal_historyStepped (const std::string &)
	signal_historyStepped is fired when the user steps through the command line history (e.g. when pressing the up arrow). More...

Public Member Functions
	CommandLineEdit (QWidget *parent=nullptr)
virtual	~CommandLineEdit ()
void	clearHistory ()
	clearHistory Wipe the history of commands entered this session. More...
std::vector< std::string >	getHistory () const
	getHistory Gets the history of commands entered this session, oldest first. More...
void	setHistory (const std::vector< std::string > &history)
	setHistory Sets the history of commands. More...
void	setCompletionList (const std::vector< std::string > &completionList)
	setCompletionList Sets the autocomplete list of commands. More...

Protected Member Functions
void	changeEvent (QEvent *) override

Private Member Functions
virtual void	keyPressEvent (QKeyEvent *e) override
virtual bool	focusNextPrevChild (bool next) override
virtual void	mouseDoubleClickEvent (QMouseEvent *event) override

Private Attributes
std::unique_ptr < CommandLineEditImpl >	d

Detailed Description

The CommandLineEdit class models the UI for the command line in a graphical script console.

Constructor & Destructor Documentation

geometrize::dialog::CommandLineEdit::CommandLineEdit ( QWidget *  parent = nullptr )

explicit

                                                : QWidget(parent), d{std::make_unique<CommandLineEdit::CommandLineEditImpl>(this)}
{
}

geometrize::dialog::CommandLineEdit::~CommandLineEdit ( )

virtual

{
}

Member Function Documentation

void geometrize::dialog::CommandLineEdit::changeEvent ( QEvent *  event )

overrideprotected

{
    if (event->type() == QEvent::LanguageChange) {
        d->onLanguageChange();
    }
    QWidget::changeEvent(event);
}

void geometrize::dialog::CommandLineEdit::clearHistory

(

)

clearHistory Wipe the history of commands entered this session.

{
    d->clearHistory();
}

bool geometrize::dialog::CommandLineEdit::focusNextPrevChild ( bool  next )

overrideprivatevirtual

{
    return false; // This ensures tab keypresses do not cause the widget to lose focus
}

std::vector< std::string > geometrize::dialog::CommandLineEdit::getHistory

(

)

const

getHistory Gets the history of commands entered this session, oldest first.

Returns

The history of commands entered this session.

{
    return d->getHistory();
}

void geometrize::dialog::CommandLineEdit::keyPressEvent ( QKeyEvent *  e )

overrideprivatevirtual

{
    d->keyPressEvent(e->key());
}

void geometrize::dialog::CommandLineEdit::mouseDoubleClickEvent ( QMouseEvent *  event )

overrideprivatevirtual

{
    d->mouseDoubleClickEvent();
}

void geometrize::dialog::CommandLineEdit::setCompletionList

(

const std::vector< std::string > &

completionList

)

setCompletionList Sets the autocomplete list of commands.

Parameters

completionList

The completion list to use.

{
    d->setCompletionList(completionList);
}

void geometrize::dialog::CommandLineEdit::setHistory

(

const std::vector< std::string > &

history

)

setHistory Sets the history of commands.

Parameters

history

The command history to use.

{
    d->setHistory(history);
}

void geometrize::dialog::CommandLineEdit::signal_commandSubmitted ( const std::string &  )

signal

signal_commandSubmitted is fired when a command is submitted by the user (e.g. after pressing return).

Here is the caller graph for this function:

void geometrize::dialog::CommandLineEdit::signal_historyStepped ( const std::string &  )

signal

signal_historyStepped is fired when the user steps through the command line history (e.g. when pressing the up arrow).

Here is the caller graph for this function:

Member Data Documentation

std::unique_ptr<CommandLineEditImpl> geometrize::dialog::CommandLineEdit::d

private

---

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

• /home/travis/build/Tw1ddle/geometrize-docs/geometrize/geometrize/dialog/commandlineedit.h
• /home/travis/build/Tw1ddle/geometrize-docs/geometrize/geometrize/dialog/commandlineedit.cpp