1.1 --- a/epoc32/include/caf/f32agentui.h Wed Mar 31 12:27:01 2010 +0100
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,107 +0,0 @@
1.4 -/*
1.5 -* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 -* All rights reserved.
1.7 -* This component and the accompanying materials are made available
1.8 -* under the terms of the License "Eclipse Public License v1.0"
1.9 -* which accompanies this distribution, and is available
1.10 -* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 -*
1.12 -* Initial Contributors:
1.13 -* Nokia Corporation - initial contribution.
1.14 -*
1.15 -* Contributors:
1.16 -*
1.17 -* Description:
1.18 -* This defines an interface used by the F32 Agent to display information on
1.19 -* the screen. The default implementation does nothing. Licensees wishing to allow the F32
1.20 -* agent to display information on the screen should replace this DLL with
1.21 -* a DLL that does display information on screen.
1.22 -*
1.23 -*/
1.24 -
1.25 -
1.26 -
1.27 -
1.28 -/**
1.29 - @file
1.30 - @publishedPartner
1.31 - @released
1.32 -*/
1.33 -
1.34 -#ifndef __F32AGENTUI_H__
1.35 -#define __F32AGENTUI_H__
1.36 -
1.37 -#include <e32base.h>
1.38 -
1.39 -class RFile;
1.40 -
1.41 -namespace ContentAccess
1.42 - {
1.43 - /** Interface that must be implemented in order for the F32 agent to display
1.44 - information on the screen
1.45 - */
1.46 - class CF32AgentUi : public CBase
1.47 - {
1.48 - public:
1.49 - /** The implementation of this API will display a dialog asking the user to confirm deletion
1.50 - of a file. The implementation will display the dialog if the appropriate setting,
1.51 - TAgentProperty::EAgentPropertyAgentUI, has been set using CF32AgentUi::SetProperty, enabling
1.52 - the Agent UI. If the user selects to delete the file ETrue will be returned, EFalse if the
1.53 - file is not to be deleted. If the Agent UI is not enabled a default value of ETrue will be
1.54 - returned.
1.55 -
1.56 - The function should only return once the dialog has completed
1.57 -
1.58 - @param aFileName The name of the file that is about to be deleted
1.59 - @return Whether to delete the file
1.60 - @return ETrue If the file is to be deleted
1.61 - @return EFalse If the file is not to be deleted
1.62 - */
1.63 - virtual TBool ConfirmDeleteL(const TDesC& aFileName) = 0;
1.64 -
1.65 -
1.66 - /** Display information describing the supplied file
1.67 -
1.68 - The file will already be open before calling this function.
1.69 - The function should only return once the dialog has completed
1.70 -
1.71 - @param aInfo The information to display, from ContentAccess::TDisplayInfo
1.72 - @param aFile The file to display
1.73 - @return KErrNone or one of the system wide error codes
1.74 - */
1.75 - virtual void DisplayInfoL(TInt aInfo, RFile& aFile) = 0;
1.76 -
1.77 - /** The implementation of this API will action/remember Agent properties applicable to the Agent UI.
1.78 -
1.79 - Currently the F32 Agent only supports one UI property - TAgentProperty::EAgentPropertyAgentUI,
1.80 - enabling or disabling the Agent UI. The implementation of this function should store the property
1.81 - that has been set and subsequent requests to the interface should be dealt with in accordance
1.82 - with these properties.
1.83 -
1.84 - @see CF32AgentUi::ConfirmDeleteL
1.85 -
1.86 - The implementation will return KErrNone if the property has been set correctly or KErrCANotSupported
1.87 - if the property supplied is not supported.
1.88 -
1.89 - @param aProperty The property to set, from ContentAccess::TAgentProperty
1.90 - @param aValue The value of the property
1.91 - @return Whether the property was set
1.92 - @return KErrNone if the property was set correctly
1.93 - @return KErrCANotSupported if the property is not supported
1.94 - */
1.95 - virtual TInt SetProperty(TInt aProperty, TInt aValue) = 0;
1.96 - };
1.97 -
1.98 - /** Factory function that creates the F32 Agent UI
1.99 - @return a CF32AgentUi object
1.100 - */
1.101 - class TF32AgentUiFactory
1.102 - {
1.103 - public:
1.104 - IMPORT_C static CF32AgentUi* CreateF32AgentUiL();
1.105 - };
1.106 - }
1.107 -
1.108 -
1.109 -
1.110 -#endif // __F32AGENTUI_H__