libopie API Documentation
Overview Class Hierarchy Classes Classes (annotated) Members Source Files Todo

Opie::ODeviceButton Class Reference

This class represents a physical button on a Qtopia device. A representation of buttons. More...

#include <odevicebutton.h>

Collaboration diagram for Opie::ODeviceButton:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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)

Detailed Description

This class represents a physical button on a Qtopia device. A representation of buttons.

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.

Member Function Documentation

ushort ODeviceButton::keycode (   )  const
 

Returns the button's keycode.

Definition at line 142 of file odevicebutton.cpp.

QString ODeviceButton::userText (   )  const
 

This function returns a human readable, translated description of the button.

Definition at line 151 of file odevicebutton.cpp.

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 160 of file odevicebutton.cpp.

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 169 of file odevicebutton.cpp.

Referenced by pressedAction().

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 178 of file odevicebutton.cpp.

References factoryPresetPressedAction().

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 189 of file odevicebutton.cpp.

Referenced by heldAction().

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 198 of file odevicebutton.cpp.

References factoryPresetHeldAction().

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for OPIE Version 1.1.
Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:25:08 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001