SaX::SaXManipulatePointers Class Reference

SaX2 - Base pointer class. More...

#include <pointers.h>

Inheritance diagram for SaX::SaXManipulatePointers:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void setDriver (const QString &)
void setDevice (const QString &)
void setProtocol (const QString &)
void setNamePair (const QString &, const QString &)
void setOption (const QString &, const QString &=0)
void addOption (const QString &, const QString &=0)
void removeOption (const QString &)
QString getDevice (void)
QString getDriver (void)
QString getProtocol (void)
QDict< QString > getOptions (void)
bool selectPointer (int)

Protected Member Functions

 SaXManipulatePointers (SaXImport *, int=1)

Protected Attributes

SaXImportmImport
int mPointer

Detailed Description

SaX2 - Base pointer class.

The manipulate pointers class is the base class for all supported pointer devices Mice, Tablets and Touchscreens. It is not possible to create an object of type SaXManipulatePointers because the class contains only methods which are common to all pointer devices and can be used within the derived classes.

Definition at line 80 of file pointers.h.


Constructor & Destructor Documentation

SaX::SaXManipulatePointers::SaXManipulatePointers SaXImport in,
int  ptr = 1
[protected]
 

This baseclass is used to provide common pointer manipulation methods for the devices Mice Tablets and Touchscreens. it provides a protected constructor only. Therefore it is not possible to create an object of this type

Definition at line 25 of file pointers.cpp.

References SaX::SaXException::errorString(), SaX::SaXException::excNullPointerArgument(), SaX::SaXException::excPointerImportBindFailed(), and SaX::SaXImport::getSectionID().

Here is the call graph for this function:


Member Function Documentation

void SaX::SaXManipulatePointers::addOption const QString &  keyword,
const QString &  value = 0
[virtual]
 

add a pointer option to the currently selected pointer device. If the value is set to NULL the "Option" list will be enhances otherwise the "RawOption" list will be increased.

Implements SaX::SaXManipulatePointersIF.

Definition at line 165 of file pointers.cpp.

References SaX::SaXStorage::addItem(), SaX::SaXStorage::addRawItem(), and mImport.

Here is the call graph for this function:

QString SaX::SaXManipulatePointers::getDevice void   )  [virtual]
 

return the device name the pointer device is connected to. Note this may be an alias name concerning the type of the pointer device

Implements SaX::SaXManipulatePointersIF.

Definition at line 225 of file pointers.cpp.

References mImport.

QString SaX::SaXManipulatePointers::getDriver void   )  [virtual]
 

return the driver used for this pointer device

Implements SaX::SaXManipulatePointersIF.

Definition at line 240 of file pointers.cpp.

References mImport.

Referenced by SaX::SaXManipulateMice::isMouse().

QDict< QString > SaX::SaXManipulatePointers::getOptions void   )  [virtual]
 

retrieve an option list of all options set for this pointer device. The storage is a dictionary saving the option name as key and the options value as value for this key. If there is no value set for the option (bool options) the value for the key is the (null) string

Implements SaX::SaXManipulatePointersIF.

Definition at line 266 of file pointers.cpp.

References mImport.

QString SaX::SaXManipulatePointers::getProtocol void   )  [virtual]
 

return the protocol used for this pointer device

Implements SaX::SaXManipulatePointersIF.

Definition at line 253 of file pointers.cpp.

References mImport.

void SaX::SaXManipulatePointers::removeOption const QString &  value  )  [virtual]
 

remove a pointer option from the currently selected pointer device. If the value is set to NULL the value will be removed from the "Option" list otherwise the option is removed from the "RawOption" list

Implements SaX::SaXManipulatePointersIF.

Definition at line 197 of file pointers.cpp.

References SaX::SaXStorage::getItem(), mImport, and SaX::SaXStorage::removeItem().

Here is the call graph for this function:

bool SaX::SaXManipulatePointers::selectPointer int  ptr  )  [virtual]
 

select the pointer device the changes should be applied to if the device does not exist (false) is returned

Implements SaX::SaXManipulatePointersIF.

Definition at line 50 of file pointers.cpp.

References mImport, and mPointer.

Referenced by SaX::SaXManipulateTablets::removePen().

void SaX::SaXManipulatePointers::setDevice const QString &  device  )  [virtual]
 

set pointer device which provide the raw data for the pointer device. Some drivers support some sort of autodetection in this case a keywoard instead of the /dev/... path can be used

Implements SaX::SaXManipulatePointersIF.

Definition at line 82 of file pointers.cpp.

References mImport.

void SaX::SaXManipulatePointers::setDriver const QString &  driver  )  [virtual]
 

set global mouse driver to use with this configuration. the default mouse driver is named "mouse"

Implements SaX::SaXManipulatePointersIF.

Definition at line 68 of file pointers.cpp.

References mImport.

void SaX::SaXManipulatePointers::setNamePair const QString &  vendor,
const QString &  name
[virtual]
 

set a name tag to the configuration which consists of a vendor and a model name separated by a semicolon. xorg's config file does not provide native keywords for vendor or name tags, but they are needed to be able so select a component within a user interface.

Implements SaX::SaXManipulatePointersIF.

Definition at line 112 of file pointers.cpp.

References mImport.

void SaX::SaXManipulatePointers::setOption const QString &  keyword,
const QString &  value = 0
[virtual]
 

set a pointer option to the currently selected pointer device. If the value is set to NULL the keyword "Option" is used otherwise "RawOption" will be set.

Implements SaX::SaXManipulatePointersIF.

Definition at line 133 of file pointers.cpp.

References mImport, SaX::SaXStorage::setItem(), and SaX::SaXStorage::setRawItem().

Here is the call graph for this function:

void SaX::SaXManipulatePointers::setProtocol const QString &  protocol  )  [virtual]
 

set the protocol name for this pointer device some drivers support some sort of AUTO protocols

Implements SaX::SaXManipulatePointersIF.

Definition at line 98 of file pointers.cpp.

References mImport.


The documentation for this class was generated from the following files:
Generated on Mon Jan 7 17:39:25 2008 for libsax by  doxygen 1.4.6