![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Note: This example is designed to work with Techview and there is no guarantee that it will work on other interfaces
The example files can be found in examples/Messaging/TextMTM/txtu
The files reproduced here are the main files contained in the examples directory. Some extra files may be needed to run the examples, and these will be found in the appropriate examples directory.
// TXTU.H
//
// Copyright (c) 2000 Symbian Ltd. All rights reserved.
#if !defined(__TXTU_H__)
#define __TXTU_H__
#if !defined(__MTMUIBAS_H__)
#include <MTMUIBAS.H>
#endif
#if !defined(__EIKCFDLG_H__)
#include <eikcfdlg.H>//save as dialog
#endif
#if !defined(__TXUT_H__)
#include "txut.h" //service settings
#endif
//
// CTextMtmExportToFileDialog: export to file dialog
//
class CTextMtmExportToFileDialog : public CEikFileSaveAsDialog
{
public:
CTextMtmExportToFileDialog(TDes* aFileName, const TDesC* aTitle);
void PreLayoutDynInitL();
private:
const TDesC& iTitleBuf;
};
//
// CTextMtmEditServiceDialog: service setup dialog
//
class CTextMtmEditServiceDialog : public CEikDialog
{
public:
CTextMtmEditServiceDialog(TMTMTxtSettings& aTxtSettings);
void PreLayoutDynInitL();
private:
TBool OkToExitL(TInt aButtonId);
private:
TMTMTxtSettings& iTxtSettings;
};
//
// CTextMtmUi: User Interface MTM
//
class CTextMtmUi : public CBaseMtmUi
{
public:
// Construction
static CTextMtmUi* NewL(CBaseMtm& aBaseMtm, CRegisteredMtmDll& aRegisteredMtmDll);
// Destruction
~CTextMtmUi();
CMsvOperation* CancelL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection);
// Context-specific
CMsvOperation* OpenL(TRequestStatus& aStatus);
CMsvOperation* OpenL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection);
CMsvOperation* CloseL(TRequestStatus& aStatus);
CMsvOperation* CloseL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection);
// Launches editor/settings dialog as appropriate
CMsvOperation* EditL(TRequestStatus& aStatus);
CMsvOperation* EditL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection) ;
// Launches viewer/settings dialog as appropriate
CMsvOperation* ViewL(TRequestStatus& aStatus);
CMsvOperation* ViewL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection);
// Copy and move
CMsvOperation* CopyToL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
CMsvOperation* MoveToL(const CMsvEntrySelection& aSelection, TRequestStatus& aStatus);
CMsvOperation* CopyFromL(const CMsvEntrySelection& aSelection, TMsvId aTargetId,
TRequestStatus& aStatus);
CMsvOperation* MoveFromL(const CMsvEntrySelection& aSelection, TMsvId aTargetId,
TRequestStatus& aStatus);
// Create/delete/undelete
CMsvOperation* CreateL(const TMsvEntry& aEntry, CMsvEntry& aParent, TRequestStatus& aStatus);
CMsvOperation* DeleteFromL(const CMsvEntrySelection& aSelection,TRequestStatus& aStatus);
CMsvOperation* DeleteServiceL(const TMsvEntry& aService, TRequestStatus& aStatus);
// MTM-specific
void InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TDes8& aParameter);
CMsvOperation* InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection, TRequestStatus& aCompletionStatus,
TDes8& aParameter);
TInt GetProgress(const TDesC8& aProgress, TBuf<EProgressStringMaxLen>& aReturnString, TInt& aTotalEntryCount, TInt& aEntriesDone,
TInt& aCurrentEntrySize, TInt& aCurrentBytesTrans) const;
CMsvOperation* ReplyL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);
CMsvOperation* ForwardL(TMsvId aDestination, TMsvPartList aPartList, TRequestStatus& aCompletionStatus);
public:
// TextMtm-specific
CMsvOperation* LaunchEditorApplicationL(TRequestStatus& aStatus, TMsvId aId, TBool aReadOnly);
protected:
// from CBaseMtmUi
void GetResourceFileName(TFileName& aFileName) const;
protected:
CTextMtmUi(CBaseMtm& aBaseMtm, CRegisteredMtmDll& aRegisteredMtmDll);
void ConstructL();
private:
CMsvOperation* DoCopyMoveToL(const CMsvEntrySelection& aSelection,
TRequestStatus& aStatus, TBool aAction);
CMsvOperation* DoCopyMoveFromL(const CMsvEntrySelection& aSelection,
TMsvId aTargetId, TRequestStatus& aStatus, TBool aAction);
void CheckValidCopyMoveDelSelectionL(const CMsvEntry& aParent,
const CMsvEntrySelection& aSelection);
// Editing routines
CMsvOperation* MessageEditL(TRequestStatus& aStatus);
CMsvOperation* ServiceEditL(TRequestStatus& aStatus);
void CreateBodyIfNoneL();
void DoExportTextFromMessageL(TMsvId anId);
CMsvEntry* GetMessageEntryLC(TMsvId anId) const;
CRichText* GetTextFromMessageStoreL(CMsvStore* aStore) const;
void SetProgressSuccess(TPckgBuf<TMsvLocalOperationProgress>& aProgress,TMsvId aId);
private:
TMsvId iServiceId;
};
//
// CEditRemoteOperation: remote edit operation
//
class CEditRemoteOperation : public CMsvOperation
{
enum TEditRemoteState
{
EStateFinished=0,
EStateEditing,
EStateCopying,
};
public:
CEditRemoteOperation(CTextMtmUi& aMtmUi, CMsvSession& aMsvSession,
TInt aPriority, TRequestStatus& aObserverRequestStatus);
~CEditRemoteOperation();
public: // from CMsvOperation
void Start(TMsvEntry& aSourceEntry);
const TDesC8& ProgressL();
public: // from CActive
void DoCancel();
void RunL();
private:
CTextMtmUi& iMtmUi;
TBuf8<10> progress;
CMsvOperation* iCopyOperation;
CMsvOperation* iEditOperation;
TEditRemoteState iState;
};
#endif // __TXTU_H__
// TXTUCMDS.H
//
// Copyright (c) 1999 Symbian Ltd. All rights reserved.
//
#ifndef __TXTUCMDS_H__
#define __TXTUCMDS_H__
#include "txtcmds.h"
//
// TTxtuCommandIds: MTM-specific command ids
//
enum TTxtuCommandIds
{
ETxtuCommandExportText=1,
ETxtuCommandRefreshMBox
};
#endif
// TXTUPAN.H
//
// Copyright (c) 1999 Symbian Ltd. All rights reserved.
//
//
// TTxtuMtmUdPanic: MTM panics
//
enum TTxtuMtmUdPanic
{
ETextMtmUiSelectionIsNotOneMessage,
ETextMtmUiOnlyWorksWithMessageEntries,
ETextMtmUiEmptySelection,
ETextMtmUiWrongMtm,
ETextMtmUiWrongEntryType,
ETextMtmUiInvalidNullPointer,
};
extern void Panic(TTxtuMtmUdPanic aPanic);
// TXTU.CPP
//
// Copyright (c) 2000 Symbian Ltd. All rights reserved.
// Standard includes
#include <txtrich.h>//CRichText
#include <EIKRTED.H> // CEikRichTextEditor
#include <APFFNDR.H>//CApaScanningAppFinder
#include <eikenv.H>//CEikonEnv
#include <eikfsel.h> //CEikFolderNameSelector
#include <eikon.hrh> //EEikBidCancel, EEikBidTab
#include <eikon.rsg>
// Messaging includes
#include <MSVUIDS.H>
#include <msvids.h>
// Specific includes
#include "txtcmds.h" //commands accepted by the server side mtms
#include "TXCLIENT.H"
#include "TXTU.HRH"
#include "TXTU.h"
#include "TXTUcmds.h"
#include "TXTUpan.h"
#include <TXTU.rsg>
#include "TXTU.HRH"
// resource file locations
#ifdef __WINS__
// on wins, assume built to z:
_LIT(KTxtuMtmUiResourceFile,"txtu.rsc");
#else
_LIT(KTxtuMtmUiResourceFile,"c:\\resource\\messaging\\txtu.rsc");
#endif
//
// CTextMtmUi: User Interface MTM
//
//
// Construction and destruction
//
CTextMtmUi* CTextMtmUi::NewL(CBaseMtm& aBaseMtm, CRegisteredMtmDll& aRegisteredMtmDll)
{
CTextMtmUi* self=new(ELeave) CTextMtmUi(aBaseMtm, aRegisteredMtmDll);
CleanupStack::PushL(self);
self->ConstructL();
CleanupStack::Pop();
return self;
}
CTextMtmUi::CTextMtmUi(CBaseMtm& aBaseMtm, CRegisteredMtmDll& aRegisteredMtmDll)
: CBaseMtmUi(aBaseMtm, aRegisteredMtmDll)
{
}
CTextMtmUi::~CTextMtmUi()
{
}
void CTextMtmUi::ConstructL()
{
CBaseMtmUi::ConstructL();
}
CMsvOperation* CTextMtmUi::CancelL(TRequestStatus& /*aStatus*/, const CMsvEntrySelection& /*aSelection*/)
{
User::Leave(KErrNotSupported); // no cancelling
return NULL;
}
void CTextMtmUi::GetResourceFileName(TFileName& aFileName) const
// Resource file loading
{
aFileName=KTxtuMtmUiResourceFile;
}
//
// Entry manipulation
//
CMsvOperation* CTextMtmUi::OpenL(TRequestStatus& aStatus)
// Open
{
__ASSERT_DEBUG(iBaseMtm.Entry().Entry().iType==KUidMsvMessageEntry,
Panic(ETextMtmUiOnlyWorksWithMessageEntries));
return EditL(aStatus);
}
CMsvOperation* CTextMtmUi::OpenL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection)
// Open selection
{
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
iBaseMtm.SwitchCurrentEntryL(aSelection.At(0));
return OpenL(aStatus);
}
CMsvOperation* CTextMtmUi::CloseL(TRequestStatus& aStatus)
{
// Close
__ASSERT_DEBUG(iBaseMtm.Entry().Entry().iType==KUidMsvMessageEntry,
Panic(ETextMtmUiOnlyWorksWithMessageEntries));
// Nothing to do for this MTM
TPckgBuf<TMsvLocalOperationProgress> progress;
SetProgressSuccess(progress,iBaseMtm.Entry().Entry().Id());
CMsvCompletedOperation* op=CMsvCompletedOperation::NewL(Session(), Type(),
progress, KMsvLocalServiceIndexEntryId,aStatus);
return op;
}
CMsvOperation* CTextMtmUi::CloseL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection)
{
// Close selection
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
iBaseMtm.SwitchCurrentEntryL(aSelection.At(0));
return CloseL(aStatus);
}
CMsvOperation* CTextMtmUi::CreateL(const TMsvEntry& aEntry, CMsvEntry& aParent,
TRequestStatus& aStatus)
// Create new entry
{
TMsvId oldId=0;
if (iBaseMtm.HasContext())
oldId = iBaseMtm.Entry().Entry().Id();
else
iBaseMtm.SwitchCurrentEntryL(KMsvRootIndexEntryId);
// Create the new entry synchronously
TMsvEntry newEntry=aEntry;
if (newEntry.iType.iUid == KUidMsvMessageEntryValue)
{
// Some extra info for new messages
_LIT(KNewText,"New Text");
newEntry.iServiceId=KMsvLocalServiceIndexEntryId;
newEntry.iDescription.Set(KNewText);
}
CMsvOperationActiveSchedulerWait* wait=CMsvOperationActiveSchedulerWait::NewLC();
CMsvOperation* op=CBaseMtmUi::CreateL(newEntry, aParent, wait->iStatus);
CleanupStack::PushL(op);
wait->Start();
TPckgBuf<TMsvLocalOperationProgress> progressPack;
progressPack.Copy(op->ProgressL());
TMsvLocalOperationProgress progress = progressPack();
User::LeaveIfError(progress.iError);
CleanupStack::PopAndDestroy(2);// op, wait
// Now edit the entry
iBaseMtm.SwitchCurrentEntryL(progress.iId);
TRAPD(ret, op=EditL(aStatus));
if (ret!=KErrNone)
{// An error has occurred before ownership of entry passed over to editor,
// so try and delete the new entry, and return context to its previous state
wait = CMsvOperationActiveSchedulerWait::NewLC();
CMsvEntry* entry=Session().GetEntryL(iBaseMtm.Entry().Entry().Parent());
CleanupStack::PushL(entry);
wait->Start();
entry->DeleteL(progress.iId);
CleanupStack::PopAndDestroy(2);// wait, entry
if (oldId)
iBaseMtm.SwitchCurrentEntryL(oldId);
User::Leave(ret);
}
return op;
}
CMsvOperation* CTextMtmUi::EditL(TRequestStatus& aStatus)
// Edit
{
TUid type = iBaseMtm.Entry().Entry().iType;
iServiceId = iBaseMtm.Entry().Entry().iServiceId;
__ASSERT_DEBUG(type==KUidMsvMessageEntry || type==KUidMsvServiceEntry,
Panic(ETextMtmUiWrongEntryType));
if ( type == KUidMsvMessageEntry )
return MessageEditL(aStatus);
else
return ServiceEditL(aStatus);
}
CMsvOperation* CTextMtmUi::MessageEditL(TRequestStatus& aStatus)
// Message editing
{
CMsvOperation* op=NULL;
// If the message is already stored locally, edit it.
if ( iServiceId == KMsvLocalServiceIndexEntryId )
{
return LaunchEditorApplicationL(aStatus, iBaseMtm.Entry().Entry().Id(), EFalse);
}
// Otherwise ask user if she wants to copy it to local
CEikDialog* dialog=new(ELeave) CEikDialog;
if (dialog->ExecuteLD(R_DIALOG_REFUSE_EDIT_REMOTE_MESSAGE))
{
TMsvEntry tEntry = iBaseMtm.Entry().Entry();
CEditRemoteOperation* edop = new (ELeave)CEditRemoteOperation(*this, Session(), 0, aStatus);
edop->Start(tEntry);
op = edop;
}
else
{
TPckgBuf<TMsvLocalOperationProgress> progress;
SetProgressSuccess(progress,iBaseMtm.Entry().Entry().Id());
op=CMsvCompletedOperation::NewL(Session(), Type(), progress, iServiceId, aStatus);
}
__ASSERT_DEBUG(op != NULL, Panic(ETextMtmUiInvalidNullPointer));
return op;
}
CMsvOperation* CTextMtmUi::ServiceEditL(TRequestStatus& aStatus)
// Service edit dialog
{
TMTMTxtSettings settings;
// load any existing settings
CTextMtmClient& mtm = static_cast<CTextMtmClient&>(BaseMtm());
// leaves if none found, which is acceptable, so ignore leave
TRAP_IGNORE(mtm.Settings().LoadSettingsL(iBaseMtm.Entry().Entry().Id(), settings));
// run the edit service settings dialog
CEikDialog* dialog=new(ELeave) CTextMtmEditServiceDialog(settings);
TPckgBuf<TMsvLocalOperationProgress> progress;
if (dialog->ExecuteLD(R_DIALOG_SERVICE_SETTINGS))
{
mtm.Settings().SaveSettingsL(iBaseMtm.Entry().Entry().Id(), settings);
// Update index entry description
TMsvEntry entry = iBaseMtm.Entry().Entry();
entry.iDetails.Set(settings.RootFolder());
iBaseMtm.Entry().ChangeL(entry);
// Send a refresh service command
CMsvEntrySelection* selection=new (ELeave) CMsvEntrySelection;
CleanupStack::PushL(selection);
selection->AppendL(iBaseMtm.Entry().Entry().Id());
CleanupStack::Pop(); //selection
TBuf8<1> scrap;
InvokeSyncFunctionL(ETxtuCommandRefreshMBox, *selection, scrap);
delete selection;
SetProgressSuccess(progress,iBaseMtm.Entry().Entry().Id());
}
else
{
progress().iTotalNumberOfEntries=1;
progress().iNumberCompleted=0;
}
return CMsvCompletedOperation::NewL(Session(), Type(), progress, iServiceId, aStatus);
}
CMsvOperation* CTextMtmUi::EditL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection)
// Edit selection
{
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
iBaseMtm.SwitchCurrentEntryL(aSelection.At(0));
return EditL(aStatus);
}
CMsvOperation* CTextMtmUi::ViewL(TRequestStatus& aStatus)
// View
{
__ASSERT_DEBUG(iBaseMtm.Entry().Entry().iType==KUidMsvMessageEntry,
Panic(ETextMtmUiOnlyWorksWithMessageEntries));
return LaunchEditorApplicationL(aStatus, iBaseMtm.Entry().Entry().Id(), ETrue);
}
CMsvOperation* CTextMtmUi::ViewL(TRequestStatus& aStatus, const CMsvEntrySelection& aSelection)
// View selection
{
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
iBaseMtm.SwitchCurrentEntryL(aSelection.At(0));
return ViewL(aStatus);
}
//
// Copy/move/delete functionality
//
CMsvOperation* CTextMtmUi::DeleteFromL(const CMsvEntrySelection& aSelection,
TRequestStatus& aStatus)
{
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
CheckValidCopyMoveDelSelectionL(BaseMtm().Entry(),aSelection);
return BaseMtm().Entry().DeleteL(aSelection, aStatus);
}
CMsvOperation* CTextMtmUi::DeleteServiceL(const TMsvEntry& aService, TRequestStatus& aStatus)
{
// remove settings from cenrep
CTextMtmClient& mtm = static_cast<CTextMtmClient&>(BaseMtm());
mtm.Settings().DeleteSettingsL(aService.Id());
return CBaseMtmUi::DeleteServiceL(aService, aStatus);
}
CMsvOperation* CTextMtmUi::CopyToL(const CMsvEntrySelection& aSelection,
TRequestStatus& aStatus)
// Copies entries in selection to the current context
{
return DoCopyMoveToL(aSelection, aStatus, ETrue);
}
CMsvOperation* CTextMtmUi::MoveToL(const CMsvEntrySelection& aSelection,
TRequestStatus& aStatus)
// Moves entries in selection to the current context
{
return DoCopyMoveToL(aSelection, aStatus, EFalse);
}
CMsvOperation* CTextMtmUi::CopyFromL(const CMsvEntrySelection& aSelection,
TMsvId aTargetId, TRequestStatus& aStatus)
// Copies entries in selection from current context to aTargetId id
{
return DoCopyMoveFromL(aSelection, aTargetId, aStatus, ETrue);
}
CMsvOperation* CTextMtmUi::MoveFromL(const CMsvEntrySelection& aSelection,
TMsvId aTargetId, TRequestStatus& aStatus)
// Moves entries in selection from current context to aTargetId id
{
return DoCopyMoveFromL(aSelection, aTargetId, aStatus, EFalse);
}
CMsvOperation* CTextMtmUi::DoCopyMoveFromL(const CMsvEntrySelection& aSelection,
TMsvId aTargetId, TRequestStatus& aStatus, TBool aAction)
// Does copy/move of entries in selection from current context to aTargetId id
{
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
const TMsvEntry& context=BaseMtm().Entry().Entry();
__ASSERT_ALWAYS(context.iType.iUid==KUidMsvServiceEntryValue ||
context.iType.iUid==KUidMsvFolderEntryValue, Panic(ETextMtmUiWrongEntryType));
CheckValidCopyMoveDelSelectionL(BaseMtm().Entry(),aSelection);
// Call the CMsvEntry copy/move functions: this will in turn call the Message Server
CMsvOperation* op=NULL;
if (aAction)
op=BaseMtm().Entry().CopyL(aSelection, aTargetId, aStatus);
else
op=BaseMtm().Entry().MoveL(aSelection, aTargetId, aStatus);
return op;
}
CMsvOperation* CTextMtmUi::DoCopyMoveToL(const CMsvEntrySelection& aSelection,
TRequestStatus& aStatus, TBool aAction)
// Perform a copy/move (depending on value of aAction)
{
__ASSERT_DEBUG(aSelection.Count(), Panic(ETextMtmUiEmptySelection));
const TMsvEntry& context=BaseMtm().Entry().Entry();
__ASSERT_ALWAYS(context.iType.iUid==KUidMsvServiceEntryValue ||
context.iType.iUid==KUidMsvFolderEntryValue, Panic(ETextMtmUiWrongEntryType));
// Find selection parent
CMsvEntry* sourceEntry=Session().GetEntryL(aSelection.At(0));
CleanupStack::PushL(sourceEntry);
TMsvId parent=sourceEntry->Entry().Parent();
sourceEntry->SetEntryL(parent);
CheckValidCopyMoveDelSelectionL(*sourceEntry,aSelection);
// Call the CMsvEntry copy/move function: this will in turn call the Message Server
CMsvOperation* op=NULL;
if (aAction)
op=sourceEntry->CopyL(aSelection, context.Id(), aStatus);
else
op=sourceEntry->MoveL(aSelection, context.Id(), aStatus);
CleanupStack::PopAndDestroy();// sourceEntry
return op;
}
void CTextMtmUi::CheckValidCopyMoveDelSelectionL(const CMsvEntry& aParent,
const CMsvEntrySelection& aSelection)
// Check selection and confirm it contains only messages
// As Server-side doesn't handle folders
{
// We have a ready-made way of getting a list of the message children to check against
CMsvEntrySelection* msgChildren=aParent.ChildrenWithTypeL(KUidMsvMessageEntry);
CleanupStack::PushL(msgChildren);
// Check each aSelection entry is a child message
TInt nChildren=aSelection.Count();
for (TInt i=0; i<nChildren; i++)
if ( msgChildren->Find(aSelection[i] ) == KErrNotFound )
User::Leave(KErrNotSupported);
CleanupStack::PopAndDestroy();// msgChildren
}
//
// MTM-specific functionality
//
void CTextMtmUi::InvokeSyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection,
TDes8& aParameter)
// Call MTM-specific function synchronously
{
if (aFunctionId==ETxtuCommandExportText)
{
__ASSERT_DEBUG(aSelection.Count()==1, Panic(ETextMtmUiSelectionIsNotOneMessage));
DoExportTextFromMessageL(aSelection.At(0));// take the first message in selection
}
else if (aFunctionId==ETxtuCommandRefreshMBox)
{
CBaseMtmUi::InvokeSyncFunctionL(KTXTMTMRefresh, aSelection, aParameter);
}
else
{
CBaseMtmUi::InvokeSyncFunctionL(aFunctionId, aSelection, aParameter);
}
}
CMsvOperation* CTextMtmUi::InvokeAsyncFunctionL(TInt aFunctionId, const CMsvEntrySelection& aSelection,
TRequestStatus& aCompletionStatus, TDes8& aParameter)
// Call MTM-specific function asynchronously
{
return CBaseMtmUi::InvokeAsyncFunctionL(aFunctionId, aSelection, aCompletionStatus, aParameter);
}
//
// Message responding
//
CMsvOperation* CTextMtmUi::ReplyL(TMsvId /*aDestination*/, TMsvPartList /*aPartlist*/, TRequestStatus& /*aCompletionStatus*/)
// Reply to message - no UI support
{
User::Leave(KErrNotSupported);
return NULL;
}
CMsvOperation* CTextMtmUi::ForwardL(TMsvId /*aDestination*/, TMsvPartList /*aPartlist*/, TRequestStatus& /*aCompletionStatus*/)
// Forwarded message - no UI support
{
User::Leave(KErrNotSupported);
return NULL;
}
//
// Progress information
//
TInt CTextMtmUi::GetProgress(const TDesC8& aProgress, TBuf<EProgressStringMaxLen>& aReturnString,
TInt& aTotalEntryCount, TInt& aEntriesDone,TInt& aCurrentEntrySize, TInt& aCurrentBytesTrans) const
// Get progress information
{
TTxtProgressBuf paramPack;
if (aProgress.Length()!=paramPack.Length())
return KErrNone;
// Only the server-side copy/move/del fill in the progress
// A good idea would be to add a flag to the progress info to show which was happening
paramPack.Copy(aProgress);
TTxtProgress progress=paramPack();
aReturnString.Zero();
_LIT(KWorking,"Working");
_LIT(KError,"Error: ");
// Progress information contains any error returned from the server-side
// It's handling here is very simple
if (progress.iErrorCode==KErrNone)
aReturnString.Append(KWorking);
else
{
aReturnString.Append(KError);
aReturnString.AppendNum(progress.iErrorCode);
}
// Copy info from progress
aTotalEntryCount=progress.iTotalMsgs;
aEntriesDone=progress.iMsgsProcessed;
// TTxtProgress doesn't hold anything about these
aCurrentEntrySize=0;
aCurrentBytesTrans=0;
return KErrNone;
}
//
// Specific to CTextMtmUi
//
void CTextMtmUi::DoExportTextFromMessageL(TMsvId anId)
// Export message text to file
{
TFileName filename(_S("C:\\"));
HBufC* title=iCoeEnv->AllocReadResourceLC(R_TEXT_MTMUI_EXPORT_DIALOG_TITLE);
CEikDialog* dialog=new(ELeave) CTextMtmExportToFileDialog(&filename, title);
if (dialog->ExecuteLD(R_EIK_DIALOG_FILE_SAVEAS))
{
// Get the entry to export the text from
CMsvEntry* messageEntry=GetMessageEntryLC(anId);
// Get the store for the message
CMsvStore* store=messageEntry->ReadStoreL();
CleanupStack::PushL(store);
// Now get the rich text from that message
CRichText* text=GetTextFromMessageStoreL(store);
// No longer need entry or store, so discard them
CleanupStack::PopAndDestroy(2);// messageEntry, store
// Now export the text to the given file
CleanupStack::PushL(text);
text->ExportAsTextL(filename, CPlainText::EOrganiseByParagraph, 80);
CleanupStack::PopAndDestroy();// text
}
CleanupStack::PopAndDestroy();// title
}
CMsvEntry* CTextMtmUi::GetMessageEntryLC(TMsvId anId) const
{
CMsvEntry* messageEntry=Session().GetEntryL(anId);
CleanupStack::PushL(messageEntry);
return messageEntry;
}
CRichText* CTextMtmUi::GetTextFromMessageStoreL(CMsvStore* aStore) const
{
CRichText* text=CRichText::NewL(iEikonEnv->SystemParaFormatLayerL(),
iEikonEnv->SystemCharFormatLayerL());
CleanupStack::PushL(text);
aStore->RestoreBodyTextL(*text);
CleanupStack::Pop();// text
return text;
}
CMsvOperation* CTextMtmUi::LaunchEditorApplicationL(TRequestStatus& aStatus, TMsvId aId,
TBool aReadOnly)
{
// In a real MTM, would launch the appropriate editor/viewer, and return a controlling CMsvOperation
// Here we just pretend...
if (aReadOnly)
iEikonEnv->InfoMsg(R_TEXT_MTMUI_VIEWER_MESSAGE);
else
{
// For editing, append a bit of text to the message
iEikonEnv->InfoMsg(R_TEXT_MTMUI_EDIT_MESSAGE);
_LIT(KEdited,"Edited document\n");
iBaseMtm.SwitchCurrentEntryL(aId);
CreateBodyIfNoneL();
iBaseMtm.LoadMessageL();
TInt docEnd=iBaseMtm.Body().DocumentLength();
iBaseMtm.Body().InsertL(docEnd,KEdited);
iBaseMtm.SaveMessageL();
}
TPckgBuf<TMsvLocalOperationProgress> progress;
SetProgressSuccess(progress,aId);
return CMsvCompletedOperation::NewL(Session(), Type(), progress, iServiceId, aStatus);
}
void CTextMtmUi::SetProgressSuccess(TPckgBuf<TMsvLocalOperationProgress>& aProgress,TMsvId aId)
// Little utility function to set progress info
{
aProgress().iTotalNumberOfEntries=1;
aProgress().iNumberCompleted=1;
aProgress().iId=aId;
}
void CTextMtmUi::CreateBodyIfNoneL()
// Creates body text stream for context if doesn't have one already (i.e. is newly created)
{
__ASSERT_DEBUG(iBaseMtm.Entry().Entry().iType.iUid == KUidMsvMessageEntryValue,
Panic(ETextMtmUiOnlyWorksWithMessageEntries));
CMsvStore* store=iBaseMtm.Entry().EditStoreL();
CleanupStack::PushL(store);
if (!store->HasBodyTextL())
{
// Create CRichText object
CRichText* body = CRichText::NewL(iEikonEnv->SystemParaFormatLayerL(),
iEikonEnv->SystemCharFormatLayerL());
CleanupStack::PushL(body);
// Store CRichText in body
store->StoreBodyTextL(*body);
store->CommitL();
CleanupStack::PopAndDestroy(); // body
}
CleanupStack::PopAndDestroy(); // store
}
//
// CEditRemoteOperation: remote edit operation
//
CEditRemoteOperation::CEditRemoteOperation(CTextMtmUi& aMtmUi, CMsvSession& aMsvSession,
TInt aPriority, TRequestStatus& aObserverRequestStatus)
: CMsvOperation(aMsvSession, aPriority, aObserverRequestStatus), iMtmUi(aMtmUi)
{
CActiveScheduler::Add(this);
}
CEditRemoteOperation::~CEditRemoteOperation()
{
Cancel();
delete iCopyOperation;
delete iEditOperation;
}
const TDesC8& CEditRemoteOperation::ProgressL()
{
return progress;
}
void CEditRemoteOperation::DoCancel()
{
switch (iState)
{
case EStateCopying:
iCopyOperation->Cancel();
break;
case EStateEditing:
iEditOperation->Cancel();
break;
default:
break;
}
}
void CEditRemoteOperation::Start(TMsvEntry& aSourceEntry)
{
CMsvEntry* cEntry=iMsvSession.GetEntryL(aSourceEntry.Parent());
CleanupStack::PushL(cEntry);
iObserverRequestStatus = KRequestPending;
SetActive();
iCopyOperation=cEntry->CopyL(aSourceEntry.Id(), KMsvGlobalInBoxIndexEntryId, iStatus);
CleanupStack::PopAndDestroy();// cEntry
iState = EStateCopying;
}
void CEditRemoteOperation::RunL()
{
switch (iState)
{
case EStateCopying:
{
TTxtProgressBuf package;
package.Copy(iCopyOperation->ProgressL());
TMsvId newid = package().iNewId;
iStatus = KRequestPending;
SetActive();
iEditOperation = iMtmUi.LaunchEditorApplicationL(iStatus, newid, EFalse);
iState = EStateEditing;
}
break;
case EStateEditing:
{
iState = EStateFinished;
TRequestStatus *sP = &iObserverRequestStatus;
User::RequestComplete(sP,iStatus.Int());
}
break;
default:
break;
}
}
//
// CTextMtmExportToFileDialog: export to file dialog
//
CTextMtmExportToFileDialog::CTextMtmExportToFileDialog(TDes* aFileName, const TDesC* aTitle)
: CEikFileSaveAsDialog(aFileName, aTitle, NULL, EFalse),
iTitleBuf(*aTitle) // iTitle is private in CEikFileSaveAsDialog
{
}
void CTextMtmExportToFileDialog::PreLayoutDynInitL()
{
CEikFileSaveAsDialog::PreLayoutDynInitL();
SetTitleL(iTitleBuf);
}
//
// CTextMtmEditServiceDialog: service setup dialog
//
CTextMtmEditServiceDialog::CTextMtmEditServiceDialog(TMTMTxtSettings& aTxtSettings)
: iTxtSettings(aTxtSettings)
{
}
void CTextMtmEditServiceDialog::PreLayoutDynInitL()
{
TParse parse;
_LIT(KCRoot,"C:\\");
TFileName defaultName(KCRoot);
parse.Set(iTxtSettings.RootFolder(),&defaultName,&defaultName);
CEikFolderNameSelector* fsel = (CEikFolderNameSelector*)Control(ETxtEditServiceFolder);
TFileName fullName = parse.FullName();
fsel->SetFullNameL(fullName);
}
TBool CTextMtmEditServiceDialog::OkToExitL(TInt /*aButtonId*/)
{
CEikFolderNameSelector* fsel = (CEikFolderNameSelector*)Control(ETxtEditServiceFolder);
iTxtSettings.SetRootFolder(fsel->FullName());
return ETrue;
}
// TXTUDLL.CPP
//
// Copyright (c) 1999 Symbian Ltd. All rights reserved.
//
#include <E32STD.H>
#include "TXTU.H"
#include "TXTUPAN.H"
// Global function declarations
GLDEF_C void Panic(TTxtuMtmUdPanic aPanic)
// Panic function
{
_LIT(KTEXTMTMUIPanic,"TEXT MTMUI");
User::Panic(KTEXTMTMUIPanic, aPanic);
}
EXPORT_C CBaseMtmUi* NewMtmUiL(CBaseMtm& aMtm, CRegisteredMtmDll& aRegisteredDll)
// Factory function
{
return CTextMtmUi::NewL(aMtm, aRegisteredDll);
}
// TXTU.HRH
//
// Copyright (c) 1999 Symbian Ltd. All rights reserved.
//
#if !defined(__TXTU_HRH__)
#define __TXTU_HRH__
enum TEkedCommandIds
{
ESmtiCommandSend=1,
ESmtiCommandConnect,
ESmtiCommandDisonnect
};
#define ETxtEditServiceFolder 1
#define ETxtEditRemoteServiceLabel1 2
#define ETxtEditRemoteServiceLabel2 3
#endif
// TXTU.MMP
//
// Copyright (c) 2000 Symbian Ltd. All rights reserved.
target TXTU.DLL
targettype DLL
uid 0x10003C60 0x10005236
VENDORID 0x70000001
CAPABILITY All -TCB
source TXTU.CPP TXTUDLL.CPP
START RESOURCE txtu.rss
HEADER
TARGETPATH \resource\messaging
END
USERINCLUDE ..\txut
USERINCLUDE ..\txtc
systeminclude \Epoc32\include
SYSTEMINCLUDE \epoc32\include\techview
library msgs.lib euser.lib mtur.lib cone.lib eikcore.lib eikcoctl.lib eikdlg.lib eikfile.lib etext.lib efsrv.lib txut.lib
#if defined(WINS)
deffile .\txtuWINS.def
#else
deffile .\txtuEABI.def
#endif
nostrictdef
NOEXPORTLIBRARY
// TXTU.RSS
//
// Copyright (c) 1999 Symbian Ltd. All rights reserved.
//
NAME TXTU
#include <eikon.rh> //LABEL
#include <EIKON.RSG> //default resources in rom
#include "TXTUCMDS.H"
#include "TXTU.HRH"
RESOURCE RSS_SIGNATURE
{ }
RESOURCE TBUF16 { buf=""; }
RESOURCE TBUF40 r_text_mtmui_export_dialog_title { buf="Export message text to file"; }
RESOURCE TBUF40 r_text_mtmui_viewer_message { buf="Viewing message..."; }
RESOURCE TBUF40 r_text_mtmui_edit_message { buf="Editing message..."; }
RESOURCE DIALOG r_dialog_service_settings
{
flags=EEikDialogFlagWait;
title="Edit service settings";
buttons=R_EIK_BUTTONS_CANCEL_OK;
items=
{
DLG_LINE
{
prompt="Folder";
type=EEikCtFolderNameSel;
id=ETxtEditServiceFolder;
control=FOLDERNAMESELECTOR {};
}
};
}
RESOURCE DIALOG r_dialog_refuse_edit_remote_message
{
flags=EEikDialogFlagWait;
title="Edit remote message";
buttons=R_EIK_BUTTONS_CANCEL_OK;
items=
{
DLG_LINE
{
prompt="";
type=EEikCtLabel;
id=ETxtEditRemoteServiceLabel1;
control=LABEL {txt="Copy to local inbox?";};
itemflags=EEikDlgItemSeparatorAfter;
},
DLG_LINE
{
prompt="";
type=EEikCtLabel;
id=ETxtEditRemoteServiceLabel2;
control=LABEL {txt="Can not edit text on remote service"; standard_font=EEikLabelFontLegend;};
}
};
}
|
|
The txtu project demonstrates a User Interface MTM. The
central class is CTextMtmUi, derived from the User Interface MTM
base class CBaseMtmUi.
Note that the txtu project has dependencies on some GUI
components that might not be present on all Symbian OS licensee SDKs.
txtu implements the following MTM functionality:
|
|
Create(): this creates a new local message in the
Draft folder, with description field set to "New Text", and
then invokes edit.
Edit(): no UI for editing and viewing text messages is
implemented. A simple stub is provided that simply appends the text "Edited
document" to the message and puts up an information message.
If an edit command is invoked on a remote message entry (an entry under
a Text service entry), the MTM offers to copy it to the local Inbox first. This
is performed by class CEditRemoteOperation. and dialog resource
r_dialog_refuse_edit_remote_message.
Open() and View(): these functions for a
message context simply calls the edit function.
CopyToL(), MoveToL(),
CopyFromL(), MoveFromL() and DeleteL():
simple implementations of these functions are provided that use the
CMsvEntry copy, move and delete functions. These commands are
passed to the Message Server, which then passes them on to the Server-side Text
MTM.
ReplyL() and ForwardL(): there is no UI
support for message replies and forwarding.
|
|
Create() and Edit(): when requested to create
a new Text service entry, a dialog pops up allowing the user to specify the
folder associated with the service. This is performed by class
CTextMtmEditServiceDialog and resource
r_dialog_service_settings. The service entry can then be edited
later on, to change the folder.
After the service entry is created or changed, an automatic refresh will be triggered.
|
|
The following MTM-specific operations are accepted:
Refresh: this command refreshes the currently highlighted service entry. It calls the MTM-specific operations provided by the Client-side MTM to do this.
Export text to file: exports the text contained in a text message
to a file. This is performed by DoExportTextFromMessageL().
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}