tdepim/kresources/kolab/knotes/note.h

/*
    This file is part of the kolab resource - the implementation of the
    Kolab storage format. See www.kolab.org for documentation on this.

    Copyright (c) 2004 Bo Thorsen <bo@sonofthor.dk>

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

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  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 KOLAB_NOTE_H
#define KOLAB_NOTE_H

#include <kolabbase.h>

class TQDomElement;

namespace KCal {
  class Journal;
}

namespace Kolab {

/**
 * This class represents a note, and knows how to load/save it
 * from/to XML, and from/to a KCal::Journal.
 * The instances of this class are temporary, only used to convert
 * one to the other.
 */
class Note : public KolabBase {
public:
  /// Use this to parse an xml string to a journal entry
  /// The caller is responsible for deleting the returned journal
  static KCal::Journal* xmlToJournal( const TQString& xml );

  /// Use this to get an xml string describing this journal entry
  static TQString journalToXML( KCal::Journal* );

  /// Create a note object and
  explicit Note( KCal::Journal* journal = 0 );
  virtual ~Note();

  void saveTo( KCal::Journal* journal );

  virtual TQString type() const { return "Note"; }

  virtual void setSummary( const TQString& summary );
  virtual TQString summary() const;

  virtual void setBackgroundColor( const TQColor& bgColor );
  virtual TQColor backgroundColor() const;

  virtual void setForegroundColor( const TQColor& fgColor );
  virtual TQColor foregroundColor() const;

  virtual void setRichText( bool richText );
  virtual bool richText() const;

  // Load the attributes of this class
  virtual bool loadAttribute( TQDomElement& );

  // Save the attributes of this class
  virtual bool saveAttributes( TQDomElement& ) const;

  // Load this note by reading the XML file
  virtual bool loadXML( const TQDomDocument& xml );

  // Serialize this note to an XML string
  virtual TQString saveXML() const;

protected:
  // Read all known fields from this ical incidence
  void setFields( const KCal::Journal* );

  // Save all known fields into this ical incidence
  void saveTo( KCal::Incidence* ) const;

  TQString productID() const;

  TQString mSummary;
  TQColor mBackgroundColor;
  TQColor mForegroundColor;
  bool mRichText;
};

}

#endif // KOLAB_NOTE_H