DBus-1-TQt  1.0
TQT_DBusDataConverter Class Reference

#include <tqdbusdataconverter.h>

+ Collaboration diagram for TQT_DBusDataConverter:

Public Types

enum  Result { Success, InvalidSignature, InvalidArgument }
 

Public Member Functions

template<>
TQT_DBusDataConverter::Result convertFromTQT_DBusData (const TQT_DBusData &dbusData, TQRect &typeData)
 
template<>
TQT_DBusDataConverter::Result convertToTQT_DBusData (const TQRect &typeData, TQT_DBusData &dbusData)
 
template<>
TQT_DBusDataConverter::Result convertFromTQT_DBusData (const TQT_DBusData &dbusData, TQPoint &typeData)
 
template<>
TQT_DBusDataConverter::Result convertToTQT_DBusData (const TQPoint &typeData, TQT_DBusData &dbusData)
 
template<>
TQT_DBusDataConverter::Result convertFromTQT_DBusData (const TQT_DBusData &dbusData, TQSize &typeData)
 
template<>
TQT_DBusDataConverter::Result convertToTQT_DBusData (const TQSize &typeData, TQT_DBusData &dbusData)
 

Static Public Member Functions

template<class T >
static Result convertFromTQT_DBusData (const TQT_DBusData &dbusData, T &typeData)
 
template<class T >
static Result convertToTQT_DBusData (const T &typeData, TQT_DBusData &dbusData)
 

Detailed Description

Template based converter for getting complex data into or from TQT_DBusData objects.

Any data to transport over D-Bus, i.e. method/signal paramaters or properties, need to be converted into a TQT_DBusData instance.

For complex types, e.g. structures or nested containers, this can be quite some code, and will likely be needed for more than one call. Therefore it is more convenient to implement the conversions once per complex type.

Example: sending and recieving a TQRect over D-Bus. In D-Bus terminology a TQRect is a struct of four 32-bit signed integers. The code to do this manually looks like this:

TQRect rect(0, 0, 100, 100);
structMembers << TQT_DBusData::fromInt32(rect.x());
structMembers << TQT_DBusData::fromInt32(rect.y());
structMembers << TQT_DBusData::fromInt32(rect.wdth());
structMembers << TQT_DBusData::fromInt32(rect.height());
TQT_DBusData rectStruct = TQT_DBusData::fromStruct(structMembers);

and reverse (without the error checking)

TQT_DBusData dbusData; // assume we got this from a D-Bus call
TQValueList<TQT_DBusData> structMembers = dbudData.toStruct();
int x = structMembers[0].toInt32();
int y = structMembers[1].toInt32();
int w = structMembers[2].toInt32();
int h = structMembers[3].toInt32();
TQRect rect(x, y, w, h);

Rather than implementing it in the method which performs the D-Bus call, basically the same code can be used as a spezialisation of the TQT_DBusDataConverter methods and then used like this:

TQRect rect(0, 0, 100, 100);
TQT_DBusData rectStruct;
TQT_DBusDataConverter::convertToTQT_DBusData<TQRect>(rect, rectStruct);

and

TQRect rect;
TQT_DBusData dbusData; // assume we got this from a D-Bus call
TQT_DBusDataConverter::convertFromTQT_DBusData<TQRect>(dbusData, rect);
Note
The bindings library contains the spezialisations for TQRect, TQPoint and TQSize.

Definition at line 87 of file tqdbusdataconverter.h.

Member Enumeration Documentation

◆ Result

Conversion result values.

Enumerator
Success 

Conversion successfull

InvalidSignature 

Conversion failed because the passed TQT_DBusData instance does not contain data of the needed signature, e.g. too few to too many members for a struct or wrong types.

See also
TQT_DBusError::stdInvalidSignature()
InvalidArgument 

Conversion failed because the passed TQT_DBusData contained values which are not allowed, e.g. out of range for a numerical type used a an enum or flags.

See also
TQT_DBusError::stdInvalidArgs()

Definition at line 93 of file tqdbusdataconverter.h.

Member Function Documentation

◆ convertFromTQT_DBusData() [1/4]

template<>
TQT_DBusDataConverter::Result TQT_DBusDataConverter::convertFromTQT_DBusData ( const TQT_DBusData dbusData,
TQRect &  typeData 
)

Definition at line 33 of file tqdbusdataconverter.cpp.

References TQT_DBusData::Struct.

34 {
35  if (dbusData.type() != TQT_DBusData::Struct) return InvalidSignature;
36 
37  TQValueList<TQT_DBusData> members = dbusData.toStruct();
38  if (members.count() != 4) return InvalidSignature;
39 
40  TQ_INT32 values[4];
41 
42  TQValueList<TQT_DBusData>::const_iterator it = members.begin();
43  TQValueList<TQT_DBusData>::const_iterator endIt = members.end();
44  for (uint i = 0; it != endIt; ++it, ++i)
45  {
46  bool ok = false;
47  values[i] = (*it).toInt32(&ok);
48  if (!ok) return InvalidSignature;
49  }
50 
51  typeData = TQRect(values[0], values[1], values[2], values[3]);
52 
53  return Success;
54 }
Type type() const
Returns the Type of the data object.
Definition: tqdbusdata.cpp:317
TQValueList< TQT_DBusData > toStruct(bool *ok=0) const
Tries to get the encapsulated struct memberList.
Definition: tqdbusdata.cpp:698

◆ convertFromTQT_DBusData() [2/4]

template<>
TQT_DBusDataConverter::Result TQT_DBusDataConverter::convertFromTQT_DBusData ( const TQT_DBusData dbusData,
TQPoint &  typeData 
)

Definition at line 72 of file tqdbusdataconverter.cpp.

References TQT_DBusData::Struct.

73 {
74  if (dbusData.type() != TQT_DBusData::Struct) return InvalidSignature;
75 
76  TQValueList<TQT_DBusData> members = dbusData.toStruct();
77  if (members.count() != 2) return InvalidSignature;
78 
79  TQ_INT32 values[2];
80 
81  TQValueList<TQT_DBusData>::const_iterator it = members.begin();
82  TQValueList<TQT_DBusData>::const_iterator endIt = members.end();
83  for (uint i = 0; it != endIt; ++it, ++i)
84  {
85  bool ok = false;
86  values[i] = (*it).toInt32(&ok);
87  if (!ok) return InvalidSignature;
88  }
89 
90  typeData = TQPoint(values[0], values[1]);
91 
92  return Success;
93 }
Type type() const
Returns the Type of the data object.
Definition: tqdbusdata.cpp:317
TQValueList< TQT_DBusData > toStruct(bool *ok=0) const
Tries to get the encapsulated struct memberList.
Definition: tqdbusdata.cpp:698

◆ convertFromTQT_DBusData() [3/4]

template<>
TQT_DBusDataConverter::Result TQT_DBusDataConverter::convertFromTQT_DBusData ( const TQT_DBusData dbusData,
TQSize &  typeData 
)

Definition at line 109 of file tqdbusdataconverter.cpp.

References TQT_DBusData::Struct.

110 {
111  if (dbusData.type() != TQT_DBusData::Struct) return InvalidSignature;
112 
113  TQValueList<TQT_DBusData> members = dbusData.toStruct();
114  if (members.count() != 2) return InvalidSignature;
115 
116  TQ_INT32 values[2];
117 
118  TQValueList<TQT_DBusData>::const_iterator it = members.begin();
119  TQValueList<TQT_DBusData>::const_iterator endIt = members.end();
120  for (uint i = 0; it != endIt; ++it, ++i)
121  {
122  bool ok = false;
123  values[i] = (*it).toInt32(&ok);
124  if (!ok) return InvalidSignature;
125  }
126 
127  typeData = TQSize(values[0], values[1]);
128 
129  return Success;
130 }
Type type() const
Returns the Type of the data object.
Definition: tqdbusdata.cpp:317
TQValueList< TQT_DBusData > toStruct(bool *ok=0) const
Tries to get the encapsulated struct memberList.
Definition: tqdbusdata.cpp:698

◆ convertFromTQT_DBusData() [4/4]

template<class T >
static Result TQT_DBusDataConverter::convertFromTQT_DBusData ( const TQT_DBusData dbusData,
T &  typeData 
)
static

Conversion from a filled TQT_DBusData instance to a native type.

For example the implementation for TQPoint looks like this:

template <>
TQT_DBusDataConverter::convertFromTQT_DBusData<TQPoint>(const TQT_DBusData& dbusData, TQPoint& typeData)
{
if (dbusData.type() != TQT_DBusData::Struct) return InvalidSignature;
TQValueList<TQT_DBusData> members = dbusData.toStruct();
if (members.count() != 2) return InvalidSignature;
bool ok = false;
int x = members[0].toInt32(&ok);
if (!ok) return InvalidSignature;
int y = members[1].toInt32(&ok);
if (!ok) return InvalidSignature;
typeData = TQPoint(x, y);
return Success;
}

And then can be used like this:

TQT_DBusMessage reply; // assume we got this as a D-Bus call reply
TQPoint point;
{
// error handling
}
Parameters
dbusDatathe binding's data instance to get the content from
typeDatathe native type instance to put the content into
Returns
the conversion result value

◆ convertToTQT_DBusData() [1/4]

template<>
TQT_DBusDataConverter::Result TQT_DBusDataConverter::convertToTQT_DBusData ( const TQRect &  typeData,
TQT_DBusData dbusData 
)

Definition at line 57 of file tqdbusdataconverter.cpp.

References TQT_DBusData::fromInt32(), and TQT_DBusData::fromStruct().

58 {
60 
61  members << TQT_DBusData::fromInt32(typeData.x());
62  members << TQT_DBusData::fromInt32(typeData.y());
63  members << TQT_DBusData::fromInt32(typeData.width());
64  members << TQT_DBusData::fromInt32(typeData.height());
65 
66  dbusData = TQT_DBusData::fromStruct(members);
67 
68  return Success;
69 }
static TQT_DBusData fromStruct(const TQValueList< TQT_DBusData > &memberList)
Creates a data object for the given struct&#39;s memberList.
Definition: tqdbusdata.cpp:681
static TQT_DBusData fromInt32(TQ_INT32 value)
Creates a data object for the given signed 32-bit integer value.
Definition: tqdbusdata.cpp:447
+ Here is the call graph for this function:

◆ convertToTQT_DBusData() [2/4]

template<>
TQT_DBusDataConverter::Result TQT_DBusDataConverter::convertToTQT_DBusData ( const TQPoint &  typeData,
TQT_DBusData dbusData 
)

Definition at line 96 of file tqdbusdataconverter.cpp.

References TQT_DBusData::fromInt32(), and TQT_DBusData::fromStruct().

97 {
99 
100  members << TQT_DBusData::fromInt32(typeData.x());
101  members << TQT_DBusData::fromInt32(typeData.y());
102 
103  dbusData = TQT_DBusData::fromStruct(members);
104 
105  return Success;
106 }
static TQT_DBusData fromStruct(const TQValueList< TQT_DBusData > &memberList)
Creates a data object for the given struct&#39;s memberList.
Definition: tqdbusdata.cpp:681
static TQT_DBusData fromInt32(TQ_INT32 value)
Creates a data object for the given signed 32-bit integer value.
Definition: tqdbusdata.cpp:447
+ Here is the call graph for this function:

◆ convertToTQT_DBusData() [3/4]

template<>
TQT_DBusDataConverter::Result TQT_DBusDataConverter::convertToTQT_DBusData ( const TQSize &  typeData,
TQT_DBusData dbusData 
)

Definition at line 133 of file tqdbusdataconverter.cpp.

References TQT_DBusData::fromInt32(), and TQT_DBusData::fromStruct().

134 {
136 
137  members << TQT_DBusData::fromInt32(typeData.width());
138  members << TQT_DBusData::fromInt32(typeData.height());
139 
140  dbusData = TQT_DBusData::fromStruct(members);
141 
142  return Success;
143 }
static TQT_DBusData fromStruct(const TQValueList< TQT_DBusData > &memberList)
Creates a data object for the given struct&#39;s memberList.
Definition: tqdbusdata.cpp:681
static TQT_DBusData fromInt32(TQ_INT32 value)
Creates a data object for the given signed 32-bit integer value.
Definition: tqdbusdata.cpp:447
+ Here is the call graph for this function:

◆ convertToTQT_DBusData() [4/4]

template<class T >
static Result TQT_DBusDataConverter::convertToTQT_DBusData ( const T &  typeData,
TQT_DBusData dbusData 
)
static

Conversion from a native type to a TQT_DBusData instance.

For example the implementation for TQPoint looks like this:

template <>
TQT_DBusDataConversion::Result
TQT_DBusDataConversion::convertToTQT_DBusData<TQPoint>(const TQPoint& typeData, TQT_DBusData& dbusData)
{
members << TQT_DBusData::fromInt32(typeData.x());
members << TQT_DBusData::fromInt32(typeData.y());
dbusData = TQT_DBusData::fromStruct(members);
return Success;
}

And then can be used like this:

TQPoint point(-10, 100);
TQT_DBusMessage methodCall; // assume created by TQBusMessage::methodCall()
TQT_DBusData dbusData;
if (TQT_DBusDataConverter::convertToTQT_DBusData<TQPoint>(point, dbusData) != TQT_DBusDataConverter::Success)
{
// error handling
}
else
{
methodCall << dbusData;
}
Parameters
typeDatathe native type instance to get the content from
dbusDatathe binding's data instance to put the content into
Returns
the conversion result value

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