hal::PluginGui Class Reference

#include </home/runner/work/hal/hal/plugins/gui/include/gui/plugin_gui.h>

Inheritance diagram for hal::PluginGui:

Collaboration diagram for hal::PluginGui:

Public Member Functions
	PluginGui ()
std::string	get_name () const override
std::string	get_version () const override
std::string	get_description () const override
void	initialize_logging () override
bool	exec (ProgramArguments &args) override
void	set_layout_locker (bool enable) override
Public Member Functions inherited from hal::UIPluginInterface
	UIPluginInterface ()=default
virtual	~UIPluginInterface ()=default
Public Member Functions inherited from hal::BasePluginInterface
	BasePluginInterface ()=default
virtual	~BasePluginInterface ()
virtual void	initialize ()
virtual std::set< std::string >	get_dependencies () const
template<typename... Args>
void	log (const Args &... args) const
virtual void	on_load ()
virtual void	on_unload ()
virtual std::vector< AbstractExtensionInterface * >	get_extensions () const
template<typename T >
T *	get_first_extension () const
void	delete_extension (AbstractExtensionInterface *aeif)

Additional Inherited Members
Protected Attributes inherited from hal::BasePluginInterface
std::vector< AbstractExtensionInterface * >	m_extensions

Detailed Description

PluginGui is a huge plugin that provides a graphical user interface to load and work with netlists. If compiled it can be started using the '-g'/'–gui' flag.

Definition at line 63 of file plugin_gui.h.

Constructor & Destructor Documentation

PluginGui()

hal::PluginGui::PluginGui ( )

inline

Definition at line 68 of file plugin_gui.h.

References hal::BasePluginInterface::m_extensions.

Member Function Documentation

exec()

bool hal::PluginGui::exec ( ProgramArguments &  args )

overridevirtual

Executes the gui plugin.

Parameters

args	- The given program arguments.

Returns

true on success, false otherwise.

Implements hal::UIPluginInterface.

Definition at line 167 of file plugin_gui.cpp.

References Qt::AA_DontUseNativeDialogs, Qt::AA_UseHighDpiPixmaps, QCoreApplication::aboutToQuit(), QFontDatabase::addApplicationFont(), QFileDevice::close(), QObject::connect(), hal::style::debugUpdate(), QApplication::exec(), QString::fromStdString(), hal::ProgramArguments::get_original_arguments(), hal::utils::get_user_config_directory(), hal::gFileStatusManager, hal::gGraphContextManager, hal::gGuiApi, hal::gGuiState, hal::gNetlistRelay, hal::gPluginRelay, hal::gSelectionRelay, QSettings::IniFormat, hal::mGSettings, hal::myMessageOutput(), QFile::open(), QIODevice::readAll(), QIODevice::ReadOnly, QResource::registerResource(), QCoreApplication::setApplicationName(), QCoreApplication::setAttribute(), QCoreApplication::setOrganizationDomain(), QCoreApplication::setOrganizationName(), QApplication::setStyleSheet(), hal::SettingsItemDropdown::setValueNames(), QWidget::show(), hal::MainWindow::sSettingStyle, QVariant::toInt(), and hal::SettingsItemDropdown::value().

get_description()

std::string hal::PluginGui::get_description ( ) const

overridevirtual

Short description of plugin.

Returns

a short description of plugin

Reimplemented from hal::BasePluginInterface.

Definition at line 282 of file plugin_gui.cpp.

get_name()

std::string hal::PluginGui::get_name ( ) const

overridevirtual

Returns the plugin name: 'hal_gui'

Returns

the plugin name

Implements hal::BasePluginInterface.

Definition at line 272 of file plugin_gui.cpp.

get_version()

std::string hal::PluginGui::get_version ( ) const

overridevirtual

Returns the current version of the plugin.

Returns

the current version number of the plugin

Implements hal::BasePluginInterface.

Definition at line 277 of file plugin_gui.cpp.

initialize_logging()

void hal::PluginGui::initialize_logging ( )

overridevirtual

Adds all gui related channels to the LogManager.

Reimplemented from hal::BasePluginInterface.

Definition at line 287 of file plugin_gui.cpp.

References hal::LogManager::add_channel(), hal::LogManager::create_file_sink(), hal::LogManager::create_gui_sink(), hal::LogManager::create_stdout_sink(), and hal::LogManager::get_instance().

set_layout_locker()

void hal::PluginGui::set_layout_locker ( bool  enable )

overridevirtual

Call to block layouter.

Can be enabled multiple times, but each enable must be match by disable to remove the lock.

Parameters

[in]

enable

Enable lock on true, disable on false

Implements hal::UIPluginInterface.

Definition at line 303 of file plugin_gui.cpp.

References hal::enable.

---

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

• plugins/gui/include/gui/plugin_gui.h
• plugins/gui/src/plugin_gui.cpp