--- a/qthighway/xqserviceutil/src/xqserviceutil.cpp Wed Aug 18 10:38:12 2010 +0300
+++ b/qthighway/xqserviceutil/src/xqserviceutil.cpp Thu Sep 02 21:20:48 2010 +0300
@@ -108,6 +108,12 @@
// ======== MEMBER FUNCTIONS ========
+
+/*!
+ Send service application to backround in asynchronous service call.
+ \param value Defines should application be send to backround (if set to true)
+ or to be brought back to foreground (if set to false)
+*/
void XQServiceUtil::toBackground( bool value )
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::toBackground");
@@ -133,62 +139,126 @@
}
}
+/*!
+ Check if service application is being launched as an embedded application.
+ This information is passed in the command line arguments to started service application.
+ \return true if service application is as an embedded application, otherwise false.
+*/
bool XQServiceUtil::isEmbedded()
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::isEmbedded");
return isKeySet(QString::fromLatin1(XQServiceUtils::StartupArgEmbedded));
}
+/*!
+ Check if service application is being launched as service (other include stand-alone launch
+ or activity launch). This information is valid upon service application launch. It is passed
+ in the command line arguments so can be used already in main() function before initializing any UI.
+ \return true if launched as service, false otherwise (lanched as stand-alone or activity or other mode).
+*/
bool XQServiceUtil::isService()
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::isService");
return isKeySet(QString::fromLatin1(XQServiceUtils::StartupArgService));
}
+/*!
+ Returns the interface name part of the full service name to be called later.
+ This information is valid upon service application launch. It is passed
+ in the command line arguments so can be used already in main() function before
+ initializing any UI. For example for initializing only necessary components,
+ for generating interface specific UI etc.
+ \return Interface name part of the full service name.
+ - \b Note: The service name part should be known already by the service provider implicitly.
+*/
QString XQServiceUtil::interfaceName()
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::interfaceName");
return keyValue(QString::fromLatin1(XQServiceUtils::StartupArgInterfaceName));
}
+/*!
+ Returns the operation name within the interfaceName() to be called later.
+ This information is valid upon service application launch. It is passed
+ in the command line arguments so can be used already in main() function before
+ initializing any UI. For example for initializing only necessary components
+ for the coming slot call.
+ \return Operation name within the interfaceName()
+*/
QString XQServiceUtil::operationName()
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::operationName");
return keyValue(QString::fromLatin1(XQServiceUtils::StartupArgOperationName));
}
+/*!
+
+*/
QString XQServiceUtil::serviceName()
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::serviceName");
return keyValue(QString::fromLatin1(XQServiceUtils::StartupArgServiceName));
}
+/*!
+ Check if service application is being launched as an embedded application,
+ based on passed \a argv arguments.
+ \param argc Number of command line arguments.
+ \param argv List of command line arguments.
+ \return true if service application is as an embedded application, otherwise false.
+ \sa isEmbedded()
+*/
bool XQServiceUtil::isEmbedded(int argc, char **argv)
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::isEmbedded argv");
return isKeySet(argc,argv,QString::fromLatin1(XQServiceUtils::StartupArgEmbedded));
}
-
+/*!
+ Check if service application is being launched as service (other include stand-alone launch
+ or activity launch), based on passed \a argv arguments.
+ \param argc Number of command line arguments.
+ \param argv List of command line arguments.
+ \return true if launched as service, false otherwise (lanched as stand-alone or activity or other mode).
+ \sa isService()
+*/
bool XQServiceUtil::isService(int argc, char **argv)
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::isService argv");
return isKeySet(argc,argv,QString::fromLatin1(XQServiceUtils::StartupArgService));
}
+/*!
+ Returns the interface name part of the full service name to be called later,
+ based on passed \a argv arguments.
+ \param argc Number of command line arguments.
+ \param argv List of command line arguments.
+ \return Interface name part of the full service name.
+ \sa interfaceName()
+*/
QString XQServiceUtil::interfaceName(int argc, char **argv)
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::interfaceName");
return keyValue(argc,argv,QString::fromLatin1(XQServiceUtils::StartupArgInterfaceName));
}
-
+/*!
+ Returns the operation name within the interfaceName() to be called later,
+ based on passed \a argv arguments.
+ \param argc Number of command line arguments.
+ \param argv List of command line arguments.
+ \return Operation name within the interfaceName()
+ \sa operationName()
+*/
QString XQServiceUtil::operationName(int argc, char **argv)
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::operationName argv");
return keyValue(argc,argv,QString::fromLatin1(XQServiceUtils::StartupArgOperationName));
}
+/*!
+
+*/
QString XQServiceUtil::serviceName(int argc, char **argv)
{
XQSERVICE_DEBUG_PRINT("XQServiceUtil::serviceName argv");