Qtopia library API Documentation

Ir Class Reference

The Ir class implements basic support for sending objects over an infrared communication link. More...

#include <ir.h>

Inheritance diagram for Ir:

Inheritance graph
[legend]
Collaboration diagram for Ir:

Collaboration graph
[legend]
List of all members.

Signals

void done (Ir *)

Public Member Functions

 Ir (QObject *parent=0, const char *name=0)
void send (const QString &filename, const QString &description, const QString &mimetype=QString::null)
void send (const DocLnk &doc, const QString &description)

Static Public Member Functions

bool supported ()

Detailed Description

The Ir class implements basic support for sending objects over an infrared communication link.

Both DocLnk objects and files can be sent to another device via the infrared link using the send() function. When the send has completed the done() signal is emitted.

The supported() function returns whether the device supports infrared communication or not.

Definition at line 29 of file ir.h.


Constructor & Destructor Documentation

Ir::Ir QObject parent = 0,
const char *  name = 0
 

Constructs an Ir object. The parent and name classes are the standard QObject parameters.

Definition at line 48 of file ir.cpp.

References QObject::connect().


Member Function Documentation

bool Ir::supported  )  [static]
 

Returns TRUE if the system supports infrared communication; otherwise returns FALSE.

Definition at line 62 of file ir.cpp.

References QCopChannel::isRegistered().

void Ir::send const QString fn,
const QString description,
const QString mimetype = QString::null
 

Sends the object in file fn over the infrared link. The description is used in the text shown to the user while sending is in progress. The optional mimetype parameter specifies the mimetype of the object. If this parameter is not set, it is determined by the the filename's suffix.

See also:
done()

Definition at line 78 of file ir.cpp.

References QString::isEmpty().

Referenced by send().

void Ir::send const DocLnk doc,
const QString description
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Uses the DocLnk::file() and DocLnk::type() of doc.

See also:
done()

Definition at line 95 of file ir.cpp.

References AppLnk::file(), send(), and AppLnk::type().

Ir::done Ir ir  )  [signal]
 

This signal is emitted by ir, when the send comand has been processed.


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