notes/notesui/notesplugins/noteseditorplugin/src/noteseditorplugin.cpp
author hgs
Mon, 26 Jul 2010 13:54:38 +0530
changeset 55 2c54b51f39c4
parent 45 b6db4fd4947b
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
* Definition of NotesEditorPlugin class.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
// System includes.
hgs
parents:
diff changeset
    20
#include <noteseditorinterface.h>
hgs
parents:
diff changeset
    21
#include <AgendaUtil>
hgs
parents:
diff changeset
    22
#include <AgendaEntry>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// User includes.
hgs
parents:
diff changeset
    25
#include "noteseditorplugin.h"
hgs
parents:
diff changeset
    26
#include "noteseditor.h"
55
hgs
parents: 45
diff changeset
    27
#include "OstTraceDefinitions.h"
hgs
parents: 45
diff changeset
    28
#ifdef OST_TRACE_COMPILER_IN_USE
hgs
parents: 45
diff changeset
    29
#include "noteseditorpluginTraces.h"
hgs
parents: 45
diff changeset
    30
#endif
hgs
parents: 45
diff changeset
    31
45
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/*!
hgs
parents:
diff changeset
    34
	\class NotesEditorPlugin
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
	NotesEditorPlugin provides QT plugin implementation of NotesEditorInterface.
hgs
parents:
diff changeset
    37
 */
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
/*!
hgs
parents:
diff changeset
    40
	\fn void NotesEditorPlugin::editingCompleted(bool status = true)
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
	This signal is emitted when editing/creation of a note/to-do is completed.
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
	\param status This indicates whether the note/to-do was saved or not.
hgs
parents:
diff changeset
    45
					This will be `true' if the note was saved by the user.
hgs
parents:
diff changeset
    46
					false' otherwise.
hgs
parents:
diff changeset
    47
 */
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
/*!
hgs
parents:
diff changeset
    51
	Constructor.
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
	\param parent QObject pointer.
hgs
parents:
diff changeset
    54
 */
hgs
parents:
diff changeset
    55
NotesEditorPlugin::NotesEditorPlugin(QObject *parent)
hgs
parents:
diff changeset
    56
{
55
hgs
parents: 45
diff changeset
    57
	OstTraceFunctionEntry0( NOTESEDITORPLUGIN_NOTESEDITORPLUGIN_ENTRY );
45
hgs
parents:
diff changeset
    58
	Q_UNUSED(parent)
55
hgs
parents: 45
diff changeset
    59
	OstTraceFunctionExit0( NOTESEDITORPLUGIN_NOTESEDITORPLUGIN_EXIT );
45
hgs
parents:
diff changeset
    60
}
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
/*!
hgs
parents:
diff changeset
    63
	Destructor.
hgs
parents:
diff changeset
    64
 */
hgs
parents:
diff changeset
    65
NotesEditorPlugin::~NotesEditorPlugin()
hgs
parents:
diff changeset
    66
{
55
hgs
parents: 45
diff changeset
    67
	OstTraceFunctionEntry0( DUP1_NOTESEDITORPLUGIN_NOTESEDITORPLUGIN_ENTRY );
hgs
parents: 45
diff changeset
    68
	OstTraceFunctionExit0( DUP1_NOTESEDITORPLUGIN_NOTESEDITORPLUGIN_EXIT );
45
hgs
parents:
diff changeset
    69
}
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
/*!
hgs
parents:
diff changeset
    73
	Shows the noteseditor. The argument acts as the description for the note.
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
	\param string reference to file string/buffer.
hgs
parents:
diff changeset
    76
 */
hgs
parents:
diff changeset
    77
void NotesEditorPlugin::edit(const QString &string, AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
    78
{
55
hgs
parents: 45
diff changeset
    79
	OstTraceFunctionEntry0( NOTESEDITORPLUGIN_EDIT_ENTRY );
45
hgs
parents:
diff changeset
    80
	if (!mNotesEditor) {
hgs
parents:
diff changeset
    81
		createNotesEditor(agendaUtil);
hgs
parents:
diff changeset
    82
	}
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
	mNotesEditor->edit(string);
55
hgs
parents: 45
diff changeset
    85
	OstTraceFunctionExit0( NOTESEDITORPLUGIN_EDIT_EXIT );
45
hgs
parents:
diff changeset
    86
}
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
/*!
hgs
parents:
diff changeset
    89
	Shows the noteseditor by parsing a .vcs which could be of a To-do or a plain
hgs
parents:
diff changeset
    90
	.txt file which will be edited as a note.
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
	\param handle reference to QFile handle.
hgs
parents:
diff changeset
    93
 */
hgs
parents:
diff changeset
    94
void NotesEditorPlugin::edit(const QFile &handle, AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
    95
{
55
hgs
parents: 45
diff changeset
    96
	OstTraceFunctionEntry0( DUP1_NOTESEDITORPLUGIN_EDIT_ENTRY );
45
hgs
parents:
diff changeset
    97
	if (!mNotesEditor) {
hgs
parents:
diff changeset
    98
		createNotesEditor(agendaUtil);
hgs
parents:
diff changeset
    99
	}
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
	mNotesEditor->edit(handle);
55
hgs
parents: 45
diff changeset
   102
	OstTraceFunctionExit0( DUP1_NOTESEDITORPLUGIN_EDIT_EXIT );
45
hgs
parents:
diff changeset
   103
}
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
/*!
hgs
parents:
diff changeset
   106
	Shows the noteseditor, by parsing an AgendaEntry.
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
	\param entry An object of AgendaEntry.
hgs
parents:
diff changeset
   109
 */
hgs
parents:
diff changeset
   110
void NotesEditorPlugin::edit(AgendaEntry entry, AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
   111
{
55
hgs
parents: 45
diff changeset
   112
	OstTraceFunctionEntry0( DUP2_NOTESEDITORPLUGIN_EDIT_ENTRY );
45
hgs
parents:
diff changeset
   113
	if (!mNotesEditor) {
hgs
parents:
diff changeset
   114
		createNotesEditor(agendaUtil);
hgs
parents:
diff changeset
   115
	}
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
	mNotesEditor->edit(entry);
55
hgs
parents: 45
diff changeset
   118
	OstTraceFunctionExit0( DUP2_NOTESEDITORPLUGIN_EDIT_EXIT );
45
hgs
parents:
diff changeset
   119
}
hgs
parents:
diff changeset
   120
hgs
parents:
diff changeset
   121
/*!
hgs
parents:
diff changeset
   122
	Shows the noteseditor, by fetching the note using the entry id provided.
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
	\param id entry id of the note.
hgs
parents:
diff changeset
   125
 */
hgs
parents:
diff changeset
   126
void NotesEditorPlugin::edit(ulong id, AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
   127
{
55
hgs
parents: 45
diff changeset
   128
	OstTraceFunctionEntry0( DUP3_NOTESEDITORPLUGIN_EDIT_ENTRY );
45
hgs
parents:
diff changeset
   129
	if (!mNotesEditor) {
hgs
parents:
diff changeset
   130
		createNotesEditor(agendaUtil);
hgs
parents:
diff changeset
   131
	}
hgs
parents:
diff changeset
   132
hgs
parents:
diff changeset
   133
	mNotesEditor->edit(id);
55
hgs
parents: 45
diff changeset
   134
	OstTraceFunctionExit0( DUP3_NOTESEDITORPLUGIN_EDIT_EXIT );
45
hgs
parents:
diff changeset
   135
}
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
/*!
hgs
parents:
diff changeset
   138
	Creates a new note or to-do based on the create type.It lanuches the
hgs
parents:
diff changeset
   139
	respective editors for editing
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
	\type type of the editor to be shown for creating new note and new to-do
hgs
parents:
diff changeset
   142
 */
hgs
parents:
diff changeset
   143
void NotesEditorPlugin::create( NotesEditorInterface::CreateType type,
hgs
parents:
diff changeset
   144
							AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
   145
{
55
hgs
parents: 45
diff changeset
   146
	OstTraceFunctionEntry0( NOTESEDITORPLUGIN_CREATE_ENTRY );
45
hgs
parents:
diff changeset
   147
	if (!mNotesEditor) {
hgs
parents:
diff changeset
   148
		createNotesEditor(agendaUtil);
hgs
parents:
diff changeset
   149
	}
hgs
parents:
diff changeset
   150
hgs
parents:
diff changeset
   151
	mNotesEditor->create(static_cast<NotesEditor::CreateType>(type));
55
hgs
parents: 45
diff changeset
   152
	OstTraceFunctionExit0( NOTESEDITORPLUGIN_CREATE_EXIT );
45
hgs
parents:
diff changeset
   153
}
hgs
parents:
diff changeset
   154
hgs
parents:
diff changeset
   155
/*!
hgs
parents:
diff changeset
   156
	Closes the notes editor
hgs
parents:
diff changeset
   157
hgs
parents:
diff changeset
   158
	\param type Type of the close required.
hgs
parents:
diff changeset
   159
 */
hgs
parents:
diff changeset
   160
ulong NotesEditorPlugin::close( NotesEditorInterface::CloseType type,
hgs
parents:
diff changeset
   161
							AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
   162
{
55
hgs
parents: 45
diff changeset
   163
	OstTraceFunctionEntry0( NOTESEDITORPLUGIN_CLOSE_ENTRY );
45
hgs
parents:
diff changeset
   164
	if (!mNotesEditor) {
hgs
parents:
diff changeset
   165
		createNotesEditor(agendaUtil);
hgs
parents:
diff changeset
   166
	}
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
	return mNotesEditor->close(static_cast<NotesEditor::CloseType>(type));
hgs
parents:
diff changeset
   169
}
hgs
parents:
diff changeset
   170
hgs
parents:
diff changeset
   171
/*!
hgs
parents:
diff changeset
   172
	Creates notes Editor.
hgs
parents:
diff changeset
   173
 */
hgs
parents:
diff changeset
   174
void NotesEditorPlugin::createNotesEditor(AgendaUtil *agendaUtil)
hgs
parents:
diff changeset
   175
{
55
hgs
parents: 45
diff changeset
   176
	OstTraceFunctionEntry0( NOTESEDITORPLUGIN_CREATENOTESEDITOR_ENTRY );
45
hgs
parents:
diff changeset
   177
	if (agendaUtil) {
hgs
parents:
diff changeset
   178
		mNotesEditor = new NotesEditor(agendaUtil, this);
hgs
parents:
diff changeset
   179
	} else {
hgs
parents:
diff changeset
   180
		mNotesEditor = new NotesEditor(this);
hgs
parents:
diff changeset
   181
	}
hgs
parents:
diff changeset
   182
hgs
parents:
diff changeset
   183
	if (mNotesEditor) {
hgs
parents:
diff changeset
   184
		connect(
hgs
parents:
diff changeset
   185
				mNotesEditor, SIGNAL(editingCompleted(bool)),
hgs
parents:
diff changeset
   186
				this, SLOT(handleEditingCompleted(bool)));
hgs
parents:
diff changeset
   187
	}
55
hgs
parents: 45
diff changeset
   188
	OstTraceFunctionExit0( NOTESEDITORPLUGIN_CREATENOTESEDITOR_EXIT );
45
hgs
parents:
diff changeset
   189
}
hgs
parents:
diff changeset
   190
hgs
parents:
diff changeset
   191
/*!
hgs
parents:
diff changeset
   192
	Slot to handle editing completed
hgs
parents:
diff changeset
   193
 */
hgs
parents:
diff changeset
   194
void NotesEditorPlugin::handleEditingCompleted(bool status)
hgs
parents:
diff changeset
   195
{
55
hgs
parents: 45
diff changeset
   196
	OstTraceFunctionEntry0( NOTESEDITORPLUGIN_HANDLEEDITINGCOMPLETED_ENTRY );
45
hgs
parents:
diff changeset
   197
	// Emits the signal.
hgs
parents:
diff changeset
   198
	emit editingCompleted(status);
hgs
parents:
diff changeset
   199
hgs
parents:
diff changeset
   200
	// Cleanup.
hgs
parents:
diff changeset
   201
	if (mNotesEditor) {
hgs
parents:
diff changeset
   202
		mNotesEditor->deleteLater();
hgs
parents:
diff changeset
   203
	}
55
hgs
parents: 45
diff changeset
   204
	OstTraceFunctionExit0( NOTESEDITORPLUGIN_HANDLEEDITINGCOMPLETED_EXIT );
45
hgs
parents:
diff changeset
   205
}
hgs
parents:
diff changeset
   206
hgs
parents:
diff changeset
   207
// Exports plugin class NotesEditorPlugin for the target
hgs
parents:
diff changeset
   208
// plugin noteseditorplugin.
hgs
parents:
diff changeset
   209
Q_EXPORT_PLUGIN2(noteseditorplugin, NotesEditorPlugin)
hgs
parents:
diff changeset
   210
hgs
parents:
diff changeset
   211
// End of file	--Don't remove this.