summaryrefslogtreecommitdiffstats
path: root/kio/kio/kdirnotify.h
blob: 8c8051524405b8e318e5026bc4566f9d90a6d870 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* This file is part of the KDE project
   Copyright (C) 2000 David Faure <faure@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 __kdirnotify_h__
#define __kdirnotify_h__

#include <dcopobject.h>
#include <kurl.h>

/**
 * An abstract class that receives notifications of added and removed files
 * in any directory, local or remote.
 * The information comes from the konqueror/kdesktop instance where the
 * operation was done, and can interest KDirListers, bookmark handlers, etc.
 */
class KIO_EXPORT KDirNotify : public DCOPObject
{
   K_DCOP
protected:
  KDirNotify();
  virtual ~KDirNotify() {}

public:
k_dcop:
  /**
   * Notify that files have been added in @p directory
   * Note: this is ASYNC so that it can be used with a broadcast.
   * @param directory the directory that tqcontains the new files
   */
  virtual ASYNC FilesAdded( const KURL & directory ) = 0;

  /**
   * Notify that files have been deleted.
   * Note: this is ASYNC so that it can be used with a broadcast
   * @param fileList the files that have been deleted
   */
  virtual ASYNC FilesRemoved( const KURL::List & fileList ) = 0;

  /**
   * Notify that files have been changed.
   * At the moment, this is only used for new icon, but it could be
   * used for size etc. as well.
   * Note: this is ASYNC so that it can be used with a broadcast.
   * @param fileList the list of changed files
   */
  virtual ASYNC FilesChanged( const KURL::List & fileList ) = 0;

  /**
   * Notify that a file has been renamed.
   * Note: this is ASYNC so that it can be used with a broadcast
   * @param src a list containing original names of the renamed files
   * @param dst a list of original names of the renamed files
   */
  virtual ASYNC FileRenamed( const KURL &src, const KURL &dst );

  // WARNING: When adding new methods, make sure to update 
  // kdirnotify_stub.cpp and kdirnotify_stub.h manually. 
  // They are not automatically generated since they contain
  // handcoded changes.

private:
  // @internal
  static int s_serial;
protected:
    virtual void virtual_hook( int id, void* data );
};

#endif