knotes

KNotesIface.h
1 /*******************************************************************
2  KNotesIface.h -- This file defines the DCOP interface for KNotes.
3 
4  Copyright (C) 2000 by Adriaan de Groot
5  2001-2004 by Michael Brade <brade@kde.org>
6 
7  This program is free software; you can redistribute it and/or
8  modify it under the terms of the GNU General Public License
9  as published by the Free Software Foundation; either version 2
10  of the License, or (at your option) any later version.
11 
12  This program is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  GNU General Public License for more details.
16 
17  You should have received a copy of the GNU General Public License
18  along with this program; if not, write to the Free Software
19  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 *******************************************************************/
21 
22 #ifndef __KNotesIface_h__
23 #define __KNotesIface_h__
24 
25 #include <tqstring.h>
26 #include <tqmap.h>
27 
28 #include <dcopobject.h>
29 
30 
31 class KNotesIface : virtual public DCOPObject
32 {
33  K_DCOP
34 k_dcop:
42  virtual TQString newNote( const TQString& name = TQString(),
43  const TQString& text = TQString() ) = 0;
44 
53  virtual TQString newNoteFromClipboard( const TQString& name = TQString() ) = 0;
54 
59  virtual ASYNC killNote( const TQString& noteId ) = 0;
60 
66  virtual ASYNC killNote( const TQString& noteId, bool force ) = 0;
67 
72  virtual TQMap<TQString,TQString> notes() const = 0;
73 
79  virtual ASYNC setName( const TQString& noteId, const TQString& newName ) = 0;
80 
86  virtual ASYNC setText( const TQString& noteId, const TQString& newText ) = 0;
87 
93  virtual TQString name( const TQString& noteId ) const = 0;
94 
100  virtual TQString text( const TQString& noteId ) const = 0;
101 };
102 
103 #endif