--- a/Symbian3/PDK/Source/GUID-A8130D83-E684-5B6C-BDFE-EB6EE3CD49E8.dita Tue Mar 30 11:42:04 2010 +0100
+++ b/Symbian3/PDK/Source/GUID-A8130D83-E684-5B6C-BDFE-EB6EE3CD49E8.dita Tue Mar 30 11:56:28 2010 +0100
@@ -1,7 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
-<!--Arbortext, Inc., 1988-2004, v.4002-->
-<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
- "concept.dtd">
<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->
<!-- This component and the accompanying materials are made available under the terms of the License
"Eclipse Public License v1.0" which accompanies this distribution,
@@ -10,17 +7,14 @@
Nokia Corporation - initial contribution.
Contributors:
-->
+<!DOCTYPE concept
+ PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="GUID-A8130D83-E684-5B6C-BDFE-EB6EE3CD49E8" xml:lang="en"><title>Writing
-a UPS Dialog Creator</title>
-<prolog>
-<metadata>
-<keywords></keywords>
-</metadata>
-</prolog>
-<conbody>
-<section><title>Introduction</title> <p>Dialog creators are EComplug-ins that
-device creators can write to generate the dialogs containing prompts for phone
-users. </p> <p>The plug-in has an API that consists of two asynchronous functions: </p> <ul>
+a UPS Dialog Creator</title><prolog><metadata><keywords/></metadata></prolog><conbody>
+<section id="GUID-9383005F-53E7-465E-A10E-8A781EDB52E2"><title>Introduction</title> <p>Dialog
+creators are ECom plug-ins that device creators can write to generate the
+dialogs containing prompts for phone users. </p> <p>The plug-in has an API
+that consists of two asynchronous functions: </p> <ul>
<li id="GUID-96CBCE79-4F5D-5F87-AC6B-C366346447AB"><p>The <codeph>PrepareDialog()</codeph> function.
This function is called first by the UPS server. It enables the dialog creator
to query other system servers such as AppArc or the SIS registry to retrieve
@@ -34,8 +28,7 @@
</ul> <p>The UPS displays only one prompt at a time so it is possible for
there to be a delay between calling the function to prepare the dialog and
the function to display the dialog. It is also possible for other dialogs
-to be displayed between the dialog being prepared and its being displayed. </p> <p>Both <codeph>PrepareDialog()</codeph> and <codeph>DisplayDialog()</codeph
-> are asynchronous and must support cancellation through <codeph>CActive::Cancel</codeph>.
+to be displayed between the dialog being prepared and its being displayed. </p> <p>Both <codeph>PrepareDialog()</codeph> and <codeph>DisplayDialog()</codeph> are asynchronous and must support cancellation through <codeph>CActive::Cancel</codeph>.
If either function is cancelled, the dialog creator instance is destroyed
without calling further methods. </p> <p>The work split between <codeph>PrepareDialog()</codeph> and <codeph>DisplayDialog()</codeph> described
above is a recommendation, and some of the functionality could be implemented
@@ -44,9 +37,9 @@
functionality for policy evaluators. This allows multiple policy evaluators
to share common UI code. However, it is possible to deliver policy evaluator
and dialog creator plug-ins in the same DLL. </p> </section>
-<section><title>Procedure</title> <p>Dialog creators implement the <codeph>CDialogCreator</codeph> interface.
-This section shows how to implement the functions that prepare and display
-the user prompt. </p> <ol id="GUID-0F29F8B7-F303-5D42-BB95-A32B1FE13A9A">
+<section id="GUID-38974132-906B-45C9-8C38-0C9D0F396D15"><title>Procedure</title> <p>Dialog
+creators implement the <codeph>CDialogCreator</codeph> interface. This section
+shows how to implement the functions that prepare and display the user prompt. </p> <ol id="GUID-0F29F8B7-F303-5D42-BB95-A32B1FE13A9A">
<li id="GUID-9FDDAD1F-4B9A-516A-8A00-0C331F38C4CA"><p>Prepare a dialog using
the <xref href="GUID-2308E2F4-A878-3B0A-951B-EFC4908AD9BB.dita"><apiname>PrepareDialog()</apiname></xref> function. </p> </li>
<li id="GUID-45C16A52-A05E-545A-AB3A-967CCA35BB15"><p>Display the dialog using
@@ -56,8 +49,7 @@
the dialog</b> </p> <p>The parameters to <codeph>PrepareDialog()</codeph> are
mostly <codeph>const</codeph> pointers and references to the data that has
already been generated by the UPS or policy evaluator. </p> <p>The following
-table describes the parameters for the <codeph>PrepareDialog()</codeph> function: </p> <table
-id="GUID-6D139216-B6A8-55A1-8D9B-C15134198198">
+table describes the parameters for the <codeph>PrepareDialog()</codeph> function: </p> <table id="GUID-6D139216-B6A8-55A1-8D9B-C15134198198">
<tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>
<thead>
<row>
@@ -98,7 +90,7 @@
</row>
</tbody>
</tgroup>
-</table> <p><note></note> The UPS does not allow any responses to be returned
+</table> <p><note/> The UPS does not allow any responses to be returned
to the system server except those defined in the UPS policy file. If the dialog
creator returns an option that was not specified in the policy, the request
is rejected and <codeph>EUpsDecNo</codeph> is returned. </p><p>Your implementation
@@ -126,17 +118,17 @@
framework to display the dialogs. The <codeph>DoDisplayDialogL()</codeph> function
is called through a <codeph>switch</codeph> statement, which can be seen in
the full code sample at the end of this section: </p> </section>
-<section><title>Example</title> <p>The following code shows an example of
-a full implementation of the dialog creator file: </p> <codeblock id="GUID-314673F2-BBA0-56C0-A76D-07862BB4592F"
-xml:space="preserve">#<?Pub Caret1?>include "refdialogcreator.h"
-#include <ecom/implementationproxy.h>
-#include <apaid.h>
-#include <apgcli.h>
-#include <ups/promptrequest.h>
-#include <swi/sisregistrypackage.h>
-#include <swi/sisregistrysession.h>
-#include <scs/nullstream.h>
-#include <s32mem.h>
+<section id="GUID-9C1BBD11-028A-4853-98FC-BF4B881BE2AF"><title>Example</title> <p>The
+following code shows an example of a full implementation of the dialog creator
+file: </p> <codeblock id="GUID-314673F2-BBA0-56C0-A76D-07862BB4592F" xml:space="preserve">#include "refdialogcreator.h"
+#include <ecom/implementationproxy.h>
+#include <apaid.h>
+#include <apgcli.h>
+#include <ups/promptrequest.h>
+#include <swi/sisregistrypackage.h>
+#include <swi/sisregistrysession.h>
+#include <scs/nullstream.h>
+#include <s32mem.h>
static const TUint KRefDialogCreatorImplementationId = 0x10283694;
@@ -151,7 +143,7 @@
{
CRefDialogCreator* self = new (ELeave)CRefDialogCreator();
CleanupStack::PushL(self);
- self->ConstructL();
+ self->ConstructL();
CleanupStack::Pop(self);
return self;
}
@@ -246,31 +238,31 @@
// Only one state at the moment but more should be
// added for long running operators e.g. querying the SIS registry
// or resolving the client entity.
- ResolveClientNameL(iRequest->ClientSid());
+ ResolveClientNameL(iRequest->ClientSid());
// Get the vendor name for the client process
- ResolveVendorNameL(iRequest->ClientVid());
+ ResolveVendorNameL(iRequest->ClientVid());
// Server / Service localized names generated in notifier plug-in.
- iPromptData->iServerSid = iRequest->ServerSid();
- iPromptData->iServiceId = iRequest->ServiceId();
+ iPromptData->iServerSid = iRequest->ServerSid();
+ iPromptData->iServiceId = iRequest->ServiceId();
// Different dialog text is displayed depending on whether the client application
// is signed.
// N.B. Protected SID is assumed to be signed or included at ROM build.
- if (iRequest->IsClientSidProtected()) iPromptData->iFlags |= ETrustedClient;
+ if (iRequest->IsClientSidProtected()) iPromptData->iFlags |= ETrustedClient;
// Use the options specified by the policy
- iPromptData->iOptions = iPolicy->Options();
+ iPromptData->iOptions = iPolicy->Options();
// Add the descriptions of the fingerprints. This could be used
// to allow the user to grant access to all destinations
// or a single destination.
- TInt count = iFingerprints->Count();
+ TInt count = iFingerprints->Count();
for (TInt i = 0; i < count; ++i)
{
- HBufC* description = (*iFingerprints)[i]->Description().AllocLC();
- iPromptData->iDescriptions.AppendL(description);
+ HBufC* description = (*iFingerprints)[i]->Description().AllocLC();
+ iPromptData->iDescriptions.AppendL(description);
CleanupStack::Pop(description);
}
@@ -313,7 +305,7 @@
//
// In this implementation a copy of the original fingerprint is returned. However,
// it is permitted to return a different fingerprint e.g. a modifier description.
- if (iPromptResult.iDestination >= 0 && iPromptResult.iDestination < iFingerprints->Count())
+ if (iPromptResult.iDestination >= 0 && iPromptResult.iDestination < iFingerprints->Count())
{
*iFingerprint = (*iFingerprints)[iPromptResult.iDestination];
}
@@ -330,14 +322,14 @@
void CRefDialogCreator::ResolveVendorNameL(const TVendorId& aVid)
/**
Looks up the localized vendor name for the client process and writes
-this to iPromptData->iVendorName.
+this to iPromptData->iVendorName.
Typically, this would be resolved from the SIS registry or a lookup table.
@param aVid The vendor id of the client process.
*/
{
- if (iPromptData->iVendorName.Length() != 0)
+ if (iPromptData->iVendorName.Length() != 0)
{
// already obtained vendor name from SIS registry
return;
@@ -345,13 +337,13 @@
if (aVid.iId == 0x70000001)
{
- _LIT(KSymbian, "Symbian Foundation");
- iPromptData->iVendorName.Create(KSymbian);
+ _LIT(KSymbian, "XYZ Vendor");
+ iPromptData->iVendorName.Create(KSymbian);
}
else
{
_LIT(KUnknown, "Unknown vendor");
- iPromptData->iVendorName.Create(KUnknown);
+ iPromptData->iVendorName.Create(KUnknown);
}
}
@@ -386,9 +378,9 @@
if (! found)
{
RProcess clientProcess;
- User::LeaveIfError(clientProcess.Open(iRequest->ClientProcessId()));
+ User::LeaveIfError(clientProcess.Open(iRequest->ClientProcessId()));
CleanupClosePushL(clientProcess);
- iPromptData->iClientName.Create(clientProcess.FileName());
+ iPromptData->iClientName.Create(clientProcess.FileName());
CleanupStack::PopAndDestroy(&clientProcess);
}
}
@@ -414,8 +406,8 @@
err = apa.GetAppInfo(*info, TUid::Uid(aSid));
if (err == KErrNone)
{
- iPromptData->iClientName.Close();
- iPromptData->iClientName.Create(info->iCaption);
+ iPromptData->iClientName.Close();
+ iPromptData->iClientName.Create(info->iCaption);
found = ETrue;
}
else if (err != KErrNotFound)
@@ -451,8 +443,8 @@
TRAPD(err, p = r.SidToPackageL(TUid::Uid(aSid.iId)));
if (err == KErrNone)
{
- iPromptData->iClientName.Create(p->Name());
- iPromptData->iVendorName.Create(p->Vendor());
+ iPromptData->iClientName.Create(p->Name());
+ iPromptData->iVendorName.Create(p->Vendor());
found = ETrue;
delete p;
}
@@ -463,7 +455,7 @@
// From CDialogCreator
void CRefDialogCreator::PrepareDialog(
const UserPromptService::CPromptRequest& aRequest, const CPolicy& aPolicy,
- const RPointerArray<CFingerprint>& aFingerprints, const CClientEntity* aClientEntity,
+ const RPointerArray<CFingerprint>& aFingerprints, const CClientEntity* aClientEntity,
const TAny* aEvalPrivateData, TRequestStatus& aStatus)
{
aStatus = KRequestPending;
@@ -503,6 +495,4 @@
User::RequestComplete(status, KErrNone);
}
</codeblock> </section>
-</conbody>
-</concept>
-<?Pub *0000019622?>
+</conbody></concept>
\ No newline at end of file