libAccountSetup 1.0
AccountSetup::ProviderPluginProcess Class Reference

Class to manage the account provider plugins as separate processes. More...

#include <AccountSetup/ProviderPluginProcess>

Inherits QObject.

Public Slots

void quit ()
 Clean termination of the plugin process.
 

Public Member Functions

 ProviderPluginProcess (QObject *object=0)
 Constructs the account provider plugin process.
 
SetupType setupType () const
 
Accounts::Account * account () const
 Gets the account being setup by this plugin.
 
QString serviceType () const
 
WId parentWindowId () const
 Gets the platform specific identifier of the window to which this plugin UI should be modal.
 
void setReturnToAccountsList (bool value)
 Sets the variable to go to accountsPage, when plugin exits.
 
void setExitData (const QVariant &data)
 sets the exit data.
 
void setEditExistingAccount (Accounts::AccountId accountId)
 Informs accounts-ui that the already existing account which the plugin instance attempted to create, should be edited when the plugin exits.
 

Static Public Member Functions

static ProviderPluginProcessinstance ()
 Get the instance of the object.
 

Detailed Description

Class to manage the account provider plugins as separate processes.

The ProviderPluginProcess class takes care of handling the communication protocol between the client application and the account plugin process.

Definition at line 54 of file provider-plugin-process.h.

Constructor & Destructor Documentation

◆ ProviderPluginProcess()

ProviderPluginProcess::ProviderPluginProcess ( QObject * object = 0)

Constructs the account provider plugin process.

Definition at line 146 of file provider-plugin-process.cpp.

◆ ~ProviderPluginProcess()

ProviderPluginProcess::~ProviderPluginProcess ( )
virtual

Definition at line 155 of file provider-plugin-process.cpp.

Member Function Documentation

◆ account()

Accounts::Account * ProviderPluginProcess::account ( ) const

Gets the account being setup by this plugin.

Note
The returned object might not refer to an account stored on the accounts DB, if the task of this plugin is to create a new account.

Definition at line 172 of file provider-plugin-process.cpp.

◆ instance()

ProviderPluginProcess * ProviderPluginProcess::instance ( )
static

Get the instance of the object.

Definition at line 161 of file provider-plugin-process.cpp.

◆ parentWindowId()

WId ProviderPluginProcess::parentWindowId ( ) const

Gets the platform specific identifier of the window to which this plugin UI should be modal.

Definition at line 184 of file provider-plugin-process.cpp.

◆ quit

void ProviderPluginProcess::quit ( )
slot

Clean termination of the plugin process.

Definition at line 213 of file provider-plugin-process.cpp.

Referenced by setReturnToAccountsList().

◆ serviceType()

QString ProviderPluginProcess::serviceType ( ) const
Returns
The service type.

Definition at line 178 of file provider-plugin-process.cpp.

◆ setEditExistingAccount()

void ProviderPluginProcess::setEditExistingAccount ( Accounts::AccountId accountId)

Informs accounts-ui that the already existing account which the plugin instance attempted to create, should be edited when the plugin exits.

Parameters
accountIdId of the account to be edited.
Note
Use this method when attempting to create a duplicate account and a UI decision to edit the already existing account was taken.

Definition at line 206 of file provider-plugin-process.cpp.

◆ setExitData()

void ProviderPluginProcess::setExitData ( const QVariant & data)

sets the exit data.

Definition at line 200 of file provider-plugin-process.cpp.

◆ setReturnToAccountsList()

void ProviderPluginProcess::setReturnToAccountsList ( bool value)

Sets the variable to go to accountsPage, when plugin exits.

Definition at line 190 of file provider-plugin-process.cpp.

References quit().

◆ setupType()

SetupType ProviderPluginProcess::setupType ( ) const
Returns
The type of operation this plugin is expected to perform.

Definition at line 166 of file provider-plugin-process.cpp.


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