stmi::GtkDeviceManager::Init Struct Reference

Initialization data. More...

Public Attributes
bool	m_bEnableEventClasses = false
	Whether to enable or disable all (but) aEnDisableEventClasses. More...
std::vector< Event::Class >	m_aEnDisableEventClasses
	The event classes to be enabled or disabled according to m_bEnableEventClasses. More...
KeyRepeat::MODE	m_eKeyRepeatMode = KeyRepeat::MODE_NOT_SET
	How key (press) repeat is handled. More...
shared_ptr< GdkKeyConverter >	m_refGdkConverter
	The gdk key event to hardware key converter. More...
Glib::RefPtr< Gdk::Display >	m_refDisplay
	The gdk display. More...
std::string	m_sAdditionalPluginPath
	Additional directory where to look for plugin (.dlp) files. More...
bool	m_bAdditionalPluginPathOnly = false
	Only additional directory should be used. More...
bool	m_bEnablePlugins = false
	Whether to enable or disable all (but) m_aEnDisablePlugins. More...
std::vector< std::string >	m_aEnDisablePlugins
	The plugins to be enabled or disabled according to m_bEnablePlugins. More...
std::vector< std::string >	m_aGroups
	The group names the plug-ins must belong to in order to be loaded. More...
std::string	m_sAppName
	The application name. More...
bool	m_bVerbose = false
	If true more output can be expected. More...

Detailed Description

Initialization data.

If m_bEnableEventClasses is true then all event classes in m_aEnDisableEventClasses are enabled, all others disabled, if false then all event classes supported by this instance are enabled except those in m_aEnDisableEventClasses.

Example: To enable just events of type KeyEvent and PointerEvent set parameters

m_bEnableEventClasses = true,  m_aEnDisableEventClasses = {stmi::KeyEvent::getClass(), stmi::PointerEvent::getClass()}

If m_refGdkConverter is null, the stmi::GdkKeyConverterEvDev converter is used.

If the gdk display m_refDisplay is null, the system default is used.

If m_bEnablePlugins is true then all plugin names in m_aEnDisablePlugins are enabled, all others disabled, if false then all plugin names found by this instance are enabled except those in m_aEnDisablePlugins.

Example: to enable all plugins (to be understood as "don't disable any plugin name")

m_bEnablePlugins = false,  m_aEnDisablePlugins = {}   (which is the default)

m_aGroups contains the groups the plugin must belong to in order to be loaded. The groups are listed in the plugin .dlp file (see PluginsDeviceManager::PluginsDeviceManager)

Note: the plugins device manager might have been excluded for the build (libstmm-input-dl is not present) in which case these fields are unused.

Member Data Documentation

m_aEnDisableEventClasses

std::vector<Event::Class> stmi::GtkDeviceManager::Init::m_aEnDisableEventClasses

The event classes to be enabled or disabled according to m_bEnableEventClasses.

m_aEnDisablePlugins

std::vector<std::string> stmi::GtkDeviceManager::Init::m_aEnDisablePlugins

The plugins to be enabled or disabled according to m_bEnablePlugins.

m_aGroups

std::vector<std::string> stmi::GtkDeviceManager::Init::m_aGroups

The group names the plug-ins must belong to in order to be loaded.

m_bAdditionalPluginPathOnly

bool stmi::GtkDeviceManager::Init::m_bAdditionalPluginPathOnly = false

Only additional directory should be used.

Default: false.

m_bEnableEventClasses

bool stmi::GtkDeviceManager::Init::m_bEnableEventClasses = false

Whether to enable or disable all (but) aEnDisableEventClasses.

Default: false.

m_bEnablePlugins

bool stmi::GtkDeviceManager::Init::m_bEnablePlugins = false

Whether to enable or disable all (but) m_aEnDisablePlugins.

Default: false.

m_bVerbose

bool stmi::GtkDeviceManager::Init::m_bVerbose = false

If true more output can be expected.

Default: false.

m_eKeyRepeatMode

KeyRepeat::MODE stmi::GtkDeviceManager::Init::m_eKeyRepeatMode = KeyRepeat::MODE_NOT_SET

How key (press) repeat is handled.

If KeyRepeat::MODE_NOT_SET, default is used. Default: KeyRepeat::MODE_NOT_SET.

m_refDisplay

Glib::RefPtr<Gdk::Display> stmi::GtkDeviceManager::Init::m_refDisplay

The gdk display.

If null default is used.

m_refGdkConverter

shared_ptr<GdkKeyConverter> stmi::GtkDeviceManager::Init::m_refGdkConverter

The gdk key event to hardware key converter.

If null default is used.

m_sAdditionalPluginPath

std::string stmi::GtkDeviceManager::Init::m_sAdditionalPluginPath

Additional directory where to look for plugin (.dlp) files.

Can be empty.

m_sAppName

std::string stmi::GtkDeviceManager::Init::m_sAppName

The application name.

Can be empty.