knotes Library API Documentation

KNotesIface.h

00001 /******************************************************************* 00002 KNotesIface.h -- This file defines the DCOP interface for KNotes. 00003 00004 Copyright (C) 2000 by Adriaan de Groot 00005 2001-2004 by Michael Brade <brade@kde.org> 00006 00007 This program is free software; you can redistribute it and/or 00008 modify it under the terms of the GNU General Public License 00009 as published by the Free Software Foundation; either version 2 00010 of the License, or (at your option) any later version. 00011 00012 This program is distributed in the hope that it will be useful, 00013 but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00015 GNU General Public License for more details. 00016 00017 You should have received a copy of the GNU General Public License 00018 along with this program; if not, write to the Free Software 00019 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 00020 *******************************************************************/ 00021 00022 #ifndef __KNotesIface_h__ 00023 #define __KNotesIface_h__ 00024 00025 #include <qstring.h> 00026 #include <qmap.h> 00027 00028 #include <dcopobject.h> 00029 00030 00031 class KNotesIface : virtual public DCOPObject 00032 { 00033 K_DCOP 00034 k_dcop: 00042 virtual QString newNote( const QString& name = QString::null, 00043 const QString& text = QString::null ) = 0; 00044 00053 virtual QString newNoteFromClipboard( const QString& name = QString::null ) = 0; 00054 00059 virtual ASYNC showNote( const QString& noteId ) const = 0; 00060 00065 virtual ASYNC hideNote( const QString& noteId ) const = 0; 00066 00071 virtual ASYNC killNote( const QString& noteId ) = 0; 00072 00078 virtual ASYNC killNote( const QString& noteId, bool force ) = 0; 00079 00084 virtual QMap<QString,QString> notes() const = 0; 00085 00091 virtual ASYNC setName( const QString& noteId, const QString& newName ) = 0; 00092 00098 virtual ASYNC setText( const QString& noteId, const QString& newText ) = 0; 00099 00105 virtual QString name( const QString& noteId ) const = 0; 00106 00112 virtual QString text( const QString& noteId ) const = 0; 00113 00118 virtual ASYNC sync( const QString& app ) = 0; 00119 00127 virtual bool isNew( const QString& app, const QString& noteId ) const = 0; 00128 00136 virtual bool isModified( const QString& app, const QString& noteId ) const = 0; 00137 }; 00138 00139 #endif
KDE Logo
This file is part of the documentation for knotes Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Aug 27 12:50:14 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003