Opie::ODeviceButton Class Reference

A representation of buttons. More...

#include </home/clem/local/src/opie/noncore/unsupported/libopie/odevicebutton.h>

Collaboration diagram for Opie::ODeviceButton:

[legend]List of all members.

Public Member Functions
	ODeviceButton ()
virtual	~ODeviceButton ()
ushort	keycode () const
QString	userText () const
QPixmap	pixmap () const
OQCopMessage	factoryPresetPressedAction () const
OQCopMessage	pressedAction () const
OQCopMessage	factoryPresetHeldAction () const
OQCopMessage	heldAction () const
void	setKeycode (ushort keycode)
void	setUserText (const QString &text)
void	setPixmap (const QPixmap &picture)
void	setFactoryPresetPressedAction (const OQCopMessage &qcopMessage)
void	setPressedAction (const OQCopMessage &qcopMessage)
void	setFactoryPresetHeldAction (const OQCopMessage &qcopMessage)
void	setHeldAction (const OQCopMessage &qcopMessage)
Private Attributes
ushort	m_Keycode
QString	m_UserText
QPixmap	m_Pixmap
OQCopMessage	m_FactoryPresetPressedAction
OQCopMessage	m_PressedAction
OQCopMessage	m_FactoryPresetHeldAction
OQCopMessage	m_HeldAction
Private *	d

---

Detailed Description

A representation of buttons.

This class represents a physical button on a Qtopia device. A device may have n "user programmable" buttons, which are number 1..n. The location and number of buttons will vary from device to device. userText() and pixmap() may be used to describe this button to the user in help documentation.

Version:

1.0

Author:

Trolltech

Definition at line 71 of file odevicebutton.h.

---

Constructor & Destructor Documentation

ODeviceButton::ODeviceButton (   )

Definition at line 129 of file odevicebutton.cpp.

ODeviceButton::~ODeviceButton (   )  [virtual]

Definition at line 133 of file odevicebutton.cpp.

---

Member Function Documentation

OQCopMessage ODeviceButton::factoryPresetHeldAction (   )  const

This function returns the factory preset (default) action for when this button is pressed and held. The return value is a legal QCop message. Definition at line 187 of file odevicebutton.cpp. References m_FactoryPresetHeldAction. Referenced by heldAction().

OQCopMessage ODeviceButton::factoryPresetPressedAction (   )  const

This function returns the factory preset (default) action for when this button is pressed. The return value is a legal QCop message. Definition at line 167 of file odevicebutton.cpp. References m_FactoryPresetPressedAction. Referenced by pressedAction().

OQCopMessage ODeviceButton::heldAction (   )  const

This function returns the user assigned action for when this button is pressed and held. If no action is assigned, factoryPresetAction() is returned. Definition at line 196 of file odevicebutton.cpp. References Opie::OQCopMessage::channel(), factoryPresetHeldAction(), and m_HeldAction.

ushort ODeviceButton::keycode (   )  const

Returns the button's keycode. Definition at line 140 of file odevicebutton.cpp. References m_Keycode.

QPixmap ODeviceButton::pixmap (   )  const

This function returns the pixmap for this button. If there isn't one it will return an empty (null) pixmap. Definition at line 158 of file odevicebutton.cpp. References m_Pixmap.

OQCopMessage ODeviceButton::pressedAction (   )  const

This function returns the user assigned action for when this button is pressed. If no action is assigned, factoryPresetAction() is returned. Definition at line 176 of file odevicebutton.cpp. References Opie::OQCopMessage::channel(), factoryPresetPressedAction(), and m_PressedAction.

void ODeviceButton::setFactoryPresetHeldAction (  const OQCopMessage &  qcopMessage  )

Definition at line 229 of file odevicebutton.cpp. References m_FactoryPresetHeldAction.

void ODeviceButton::setFactoryPresetPressedAction (  const OQCopMessage &  qcopMessage  )

Definition at line 218 of file odevicebutton.cpp. References m_FactoryPresetPressedAction.

void ODeviceButton::setHeldAction (  const OQCopMessage &  qcopMessage  )

Definition at line 234 of file odevicebutton.cpp. References m_HeldAction.

void ODeviceButton::setKeycode (  ushort  keycode  )

Definition at line 203 of file odevicebutton.cpp. References m_Keycode.

void ODeviceButton::setPixmap (  const QPixmap &  picture  )

Definition at line 213 of file odevicebutton.cpp. References m_Pixmap.

void ODeviceButton::setPressedAction (  const OQCopMessage &  qcopMessage  )

Definition at line 224 of file odevicebutton.cpp. References m_PressedAction.

void ODeviceButton::setUserText (  const QString &  text  )

Definition at line 208 of file odevicebutton.cpp. References m_UserText.

QString ODeviceButton::userText (   )  const

This function returns a human readable, translated description of the button. Definition at line 149 of file odevicebutton.cpp. References m_UserText.

---

Member Data Documentation

Private* Opie::ODeviceButton::d [private]

Definition at line 101 of file odevicebutton.h.

OQCopMessage Opie::ODeviceButton::m_FactoryPresetHeldAction [private]

Definition at line 99 of file odevicebutton.h. Referenced by factoryPresetHeldAction(), and setFactoryPresetHeldAction().

OQCopMessage Opie::ODeviceButton::m_FactoryPresetPressedAction [private]

Definition at line 97 of file odevicebutton.h. Referenced by factoryPresetPressedAction(), and setFactoryPresetPressedAction().

OQCopMessage Opie::ODeviceButton::m_HeldAction [private]

Definition at line 100 of file odevicebutton.h. Referenced by heldAction(), and setHeldAction().

ushort Opie::ODeviceButton::m_Keycode [private]

Definition at line 94 of file odevicebutton.h. Referenced by keycode(), and setKeycode().

QPixmap Opie::ODeviceButton::m_Pixmap [private]

Definition at line 96 of file odevicebutton.h. Referenced by pixmap(), and setPixmap().

OQCopMessage Opie::ODeviceButton::m_PressedAction [private]

Definition at line 98 of file odevicebutton.h. Referenced by pressedAction(), and setPressedAction().

QString Opie::ODeviceButton::m_UserText [private]

Definition at line 95 of file odevicebutton.h. Referenced by setUserText(), and userText().

---

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

• noncore/unsupported/libopie/odevicebutton.h
• noncore/unsupported/libopie/odevicebutton.cpp

---