KNotesAppIface.h

/*******************************************************************
 KNotesIface.h  --  This file defines the DCOP interface for KNotes.

 Copyright (C) 2004 by Michael Brade <brade@kde.org>

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 as published by the Free Software Foundation; either version 2
 of the License, or (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 In addition, as a special exception, the copyright holders give
 permission to link the code of this program with any edition of
 the TQt library by Trolltech AS, Norway (or with modified versions
 of TQt that use the same license as TQt), and distribute linked
 combinations including the two.  You must obey the GNU General
 Public License in all respects for all of the code used other than
 TQt.  If you modify this file, you may extend this exception to
 your version of the file, but you are not obligated to do so.  If
 you do not wish to do so, delete this exception statement from
 your version.
*******************************************************************/

#ifndef __KNotesAppIface_h__
#define __KNotesAppIface_h__

#include <tqstring.h>
#include <tqmap.h>
#include <tqdatetime.h>

#include <dcopobject.h>


class KNotesAppIface : virtual public DCOPObject
{
    K_DCOP
k_dcop:
    virtual TQString newNote( const TQString& name = TQString(),
                             const TQString& text = TQString() ) = 0;

    virtual TQString newNoteFromClipboard( const TQString& name = TQString() ) = 0;

    virtual ASYNC killNote( const TQString& noteId ) = 0;

    virtual ASYNC killNote( const TQString& noteId, bool force ) = 0;

    virtual TQMap<TQString,TQString> notes() const = 0;

    virtual ASYNC setName( const TQString& noteId, const TQString& newName ) = 0;

    virtual ASYNC setText( const TQString& noteId, const TQString& newText ) = 0;

    virtual TQString fgColor( const TQString& noteId ) const = 0;

    virtual TQString bgColor( const TQString& noteId ) const = 0;

    virtual ASYNC setColor( const TQString& noteId, const TQString& fgColor,
                                                   const TQString& bgColor ) = 0;

    virtual TQString name( const TQString& noteId ) const = 0;

    virtual TQString text( const TQString& noteId ) const = 0;


    /******** HERE STARTS THE KNotesAppIface DCOP INTERFACE EXTENSION ********/

    virtual ASYNC showNote( const TQString& noteId ) const = 0;

    virtual ASYNC hideNote( const TQString& noteId ) const = 0;

    virtual ASYNC showAllNotes() const = 0;

    virtual ASYNC hideAllNotes() const = 0;

    virtual int width( const TQString& noteId ) const = 0;

    virtual int height( const TQString& noteId ) const = 0;

    virtual ASYNC move( const TQString& noteId, int x, int y ) const = 0;

    virtual ASYNC resize( const TQString& noteId, int width, int height ) const = 0;

    virtual ASYNC sync( const TQString& app ) = 0;

    virtual bool isNew( const TQString& app, const TQString& noteId ) const = 0;

    virtual bool isModified( const TQString& app, const TQString& noteId ) const = 0;

    virtual TQDateTime getLastModified( const TQString& noteId ) const = 0;
};

#endif