diff -r 675a964f4eb5 -r 35751d3474b7 contentmgmt/contentaccessfwfordrm/engineering/dox/UI.dox --- a/contentmgmt/contentaccessfwfordrm/engineering/dox/UI.dox Tue Jul 21 01:04:32 2009 +0100 +++ b/contentmgmt/contentaccessfwfordrm/engineering/dox/UI.dox Thu Sep 10 14:01:51 2009 +0300 @@ -1,81 +1,79 @@ -// Copyright (c) 2006-2009 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 "Symbian Foundation License v1.0" -// which accompanies this distribution, and is available -// at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html". -// -// Initial Contributors: -// Nokia Corporation - initial contribution. -// -// Contributors: -// -// Description: -//
-// It should be assumed that it is only possible for CAF agents to display -// dialogs on screen if the CAF function is called from a thread where -// a static Uikon environment exists. -//
-// CAF provides several APIs that allow a client application to request an agent to -// display information on the screen. Some agents may not support these calls and leave -// with \c KErrCANotSupported. -// Both the ContentAccess::CContent::DisplayInfoL() function and the -// ContentAccess::CManager::DisplayInfoL() function allow the application -// to display file information such as last modification date and/or DRM rights information -// CManager *manager = CManager::NewL(); -// manager->DisplayInfoL(EFileProperties, avirtualPath); -// Applications can also ask a particular agent to go into management mode, displaying configuration -// information on screen, allowing the user to view and set agent specific information. -// // create manager -// CManager *manager = CManager::NewL(); -// // Get a list of the agents -// RPointerArray theAgents; -// manager->ListAgentsL(theAgents); -// // Display management info for the first agent -// manager->DisplayManagementInfoL(*theAgents[0]); -//
-// The agents will display errors on screen when they occur. Once the error has been acknowledged by the user -// the agent will return the error code to the client application. -// If a client application does not want errors displayed on screen, it can request to disable the agent UI -// using the SetProperty() functions, e.g. ContentAccess::CContent::SetProperty(). -// The agent may ignore this request and still present dialogs on screen. -// CContent *content = CContent::NewL(URI); -// // Disable UI -// content->SetProperty(EAgentPropertyAgentUI , 0); -// // Open CData -// CData *data = content->OpenContentL(EPlay, uniqueId); -//
-// Some agents may present confirmation dialogs to the user before allowing them to perform certain operations. A -// good example would be when an application tries to delete a DRM protected file. The user may have been purchased the -// content and may have inadvertently pressed delete. The agent can present a dialog asking "are you sure?" -// The agent can then return the outcome of the delete to the application, i.e. \c KErrCancel, if the user presses cancel. -// The application can use the same SetProperty() as above to disable these dialogs, but some agents may ignore that -// request and display the dialogs regardless. -//
-// The default implementation of the F32AgentUI.DLL does not do anything. If licensees want the -// \c F32Agent to display information on the screen they should replace the existing F32AgentUI.DLL -// with one that does support display functions. -// -// - - - -/** - @page CAFUI CAF and the User Interface - - @ref UikonEnv - - @ref AppDisplay - - @ref UIErr - - @ref UIConfirmation - - @ref F32AgentUi - @section UikonEnv Uikon Environment - @section AppDisplay Applications asking the agent to display information - @code - @endcode - @code - @endcode - @section UIErr Error Handling - @code - @endcode - @section UIConfirmation Confirmation Dialogs - @section F32AgentUi F32 Agent UI -*/ +// Copyright (c) 2006-2009 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 "Symbian Foundation License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +//
+// It should be assumed that it is only possible for CAF agents to display +// dialogs on screen if the CAF function is called from a thread where +// a static Uikon environment exists. +//
+// CAF provides several APIs that allow a client application to request an agent to +// display information on the screen. Some agents may not support these calls and leave +// with \c KErrCANotSupported. +// Both the ContentAccess::CContent::DisplayInfoL() function and the +// ContentAccess::CManager::DisplayInfoL() function allow the application +// to display file information such as last modification date and/or DRM rights information +// CManager *manager = CManager::NewL(); +// manager->DisplayInfoL(EFileProperties, avirtualPath); +// Applications can also ask a particular agent to go into management mode, displaying configuration +// information on screen, allowing the user to view and set agent specific information. +// // create manager +// CManager *manager = CManager::NewL(); +// // Get a list of the agents +// RPointerArray theAgents; +// manager->ListAgentsL(theAgents); +// // Display management info for the first agent +// manager->DisplayManagementInfoL(*theAgents[0]); +//
+// The agents will display errors on screen when they occur. Once the error has been acknowledged by the user +// the agent will return the error code to the client application. +// If a client application does not want errors displayed on screen, it can request to disable the agent UI +// using the SetProperty() functions, e.g. ContentAccess::CContent::SetProperty(). +// The agent may ignore this request and still present dialogs on screen. +// CContent *content = CContent::NewL(URI); +// // Disable UI +// content->SetProperty(EAgentPropertyAgentUI , 0); +// // Open CData +// CData *data = content->OpenContentL(EPlay, uniqueId); +//
+// Some agents may present confirmation dialogs to the user before allowing them to perform certain operations. A +// good example would be when an application tries to delete a DRM protected file. The user may have been purchased the +// content and may have inadvertently pressed delete. The agent can present a dialog asking "are you sure?" +// The agent can then return the outcome of the delete to the application, i.e. \c KErrCancel, if the user presses cancel. +// The application can use the same SetProperty() as above to disable these dialogs, but some agents may ignore that +// request and display the dialogs regardless. +//
+// The default implementation of the F32AgentUI.DLL does not do anything. If licensees want the +// \c F32Agent to display information on the screen they should replace the existing F32AgentUI.DLL +// with one that does support display functions. +// +// + +/** + @page CAFUI CAF and the User Interface + - @ref UikonEnv + - @ref AppDisplay + - @ref UIErr + - @ref UIConfirmation + - @ref F32AgentUi + @section UikonEnv Uikon Environment + @section AppDisplay Applications asking the agent to display information + @code + @endcode + @code + @endcode + @section UIErr Error Handling + @code + @endcode + @section UIConfirmation Confirmation Dialogs + @section F32AgentUi F32 Agent UI +*/