GizmoDaemon Class Reference

Main GizmoDaemon class. More...

#include <GizmoDaemon.hpp>

Inheritance diagram for GizmoDaemon:

[legend]Collaboration diagram for GizmoDaemon:

[legend]List of all members.

Public Member Functions
bool	checkVersion (double Version, bool Strict)
	See if a version matches ours.
void	enterLoop ()
	Enter the main run loop.
X11FocusEvent	getCurrentFocus ()
	Get currently focused window.
bool	getDebugEnabled ()
	Is debug mode enabled?
GizmodEventHandlerInterface *	getDispatcher ()
	Get the event handler / dispatcher.
boost::shared_ptr< Gizmo >	getGizmoByFileName (std::string FileName)
	Get a Gizmo by its file name.
int	getNumGizmosByClass (GizmoClass Class)
	Get number of Gizmos of a particular class.
bool	getReloadConfig ()
	Get whether or not to reload the config file.
bool	getUseKeyboardLEDs ()
	Get whether or not to visualize on the Keyboard LEDs.
bool	getUseRemoteControl ()
	Get whether or not to allow remote control.
double	getVersion ()
	Get version string.
void	initGizmod ()
	Initialize GizmoDaemon Evolution.
bool	initialize (int argc, char **argv)
	generic init stuff, command line, etc
void	printNiceScriptInit (int Width, std::string Text1, std::string Text2, std::string Text3)
	Print a nice looking init string.
void	signalShutdown ()
	Shutdown gizmod.
	GizmoDaemon ()
	Default Constructor.
virtual	~GizmoDaemon ()
	Destructor.

---

Detailed Description

Main GizmoDaemon class.

Todo:

Replace for loops (in onFileEventRead) with boost::foreach when the new version comes out!

---

Member Function Documentation

bool GizmoDaemon::checkVersion	(	double	Version,
		bool	Strict
	)

See if a version matches ours.

Parameters:

	Version	The script's version
	Strict	If set, the versions need to exactly match otherwise the script's Version signifies a minimum version level that Gizmod needs to be

Returns:

True if versions are okay

X11FocusEvent GizmoDaemon::getCurrentFocus

(

)

Get currently focused window.

Returns:

The X11FocusEvent containing information about the currently focused window

Note that this is also implemented in Python as a property so it can be accessed as a variable by referencing ".CurrentFocus"

bool GizmoDaemon::getDebugEnabled

(

)

Is debug mode enabled?

Returns:

True if enabled

Note that this is also implemented in Python as a property so it can be accessed as a variable by referencing ".DebugEnabled"

GizmodEventHandlerInterface * GizmoDaemon::getDispatcher

(

)

Get the event handler / dispatcher.

Returns:

The dispatcher

boost::shared_ptr< Gizmo > GizmoDaemon::getGizmoByFileName

(

std::string

FileName

)

Get a Gizmo by its file name.

Parameters:

FileName

The filename of the gizmo to find

Returns:

The Gizmo (shared_ptr) or a NULL shared_ptr if not found

int GizmoDaemon::getNumGizmosByClass

(

GizmoClass

Class

)

Get number of Gizmos of a particular class.

Parameters:

Class

The desired class

Returns:

The number of Gizmos

bool GizmoDaemon::getReloadConfig

(

)

Get whether or not to reload the config file.

Returns:

True if yes

bool GizmoDaemon::getUseKeyboardLEDs

(

)

Get whether or not to visualize on the Keyboard LEDs.

Returns:

True if yes

bool GizmoDaemon::getUseRemoteControl

(

)

Get whether or not to allow remote control.

Returns:

True if yes

double GizmoDaemon::getVersion

(

)

Get version string.

Note that this is also implemented in Python as a property so it can be accessed as a variable by referencing ".Version"

void GizmoDaemon::initGizmod

(

)

Initialize GizmoDaemon Evolution.

Initialize GizmoDaemon

bool GizmoDaemon::initialize	(	int	argc,
		char **	argv
	)

generic init stuff, command line, etc

Parameters:

	argc	number of command line arguments
	argv	command line arguments

Returns:

true if the program should continue, false otherwise

load the config file, process command line options, etc

void GizmoDaemon::printNiceScriptInit	(	int	Width,
		std::string	Text1,
		std::string	Text2,
		std::string	Text3
	)

Print a nice looking init string.

Parameters:

	Width	Placement positions
	Text1	Text field 1
	Text2	Text field 2
	Text3	Text field 3

---

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

• gizmod/GizmoDaemon.hpp
• gizmod/GizmoDaemon.cpp

---