summaryrefslogtreecommitdiffstats
path: root/kabc/formats/binaryformat.h
blob: 09efde41a5ad58e0ff70b36381aa9182b87195c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*
    This file is part of libkabc.
    Copyright (c) 2002 Tobias Koenig <tokoe@kde.org>

    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.
*/
#ifndef KABC_BINARYFORMAT_H
#define KABC_BINARYFORMAT_H

#include "formatplugin.h"

namespace KABC {

class AddressBook;
class Addressee;

/**
  @short binary file format for addressbook entries.
*/
class BinaryFormat : public FormatPlugin
{
public:
  /**
   * Load single addressee from file.
   */
  bool load( Addressee &, TQFile *file );

  /**
   * Load whole addressee from file.
   */
  bool loadAll( AddressBook *, Resource *, TQFile *file );

  /**
   * Save single addressee to file.
   */
  void save( const Addressee &, TQFile *file );

  /**
   * Save all addressees to file.
   */
  void saveAll( AddressBook *, Resource *, TQFile *file );

  /**
   * Check for valid format of a file.
   */
  bool checkFormat( TQFile *file ) const;

private:
  void loadAddressee( Addressee &, TQDataStream & );
  void saveAddressee( const Addressee &, TQDataStream & );
  bool checkHeader( TQDataStream & ) const;
  void writeHeader( TQDataStream & );
};

}
#endif