summaryrefslogtreecommitdiffstats
path: root/digikam/digikam/dcopiface.h
blob: 9367e6b1eb28684076bcb4c76fc1a65bece3e773 (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
85
86
87
88
89
90
91
92
93
94
95
96
/* ============================================================
 *
 * This file is a part of digiKam project
 * http://www.digikam.org
 *
 * Date        : 2005-01-12
 * Description : a DCROP interface. 
 * 
 * Copyright (C) 2005 by Leonid Zeitlin <lz@europe.com> 
 * Copyright (C) 2006 Tom Albers <tomalbers@kde.nl>
 *
 * 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, 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.
 * 
 * ============================================================ */
 
#ifndef DCOPIFACE_H
#define DCOPIFACE_H

// TQt includes.

#include <tqobject.h>
#include <dcopobject.h>

namespace Digikam
{

/**
* This class implements a DCOP interface for DigiKam.
* At the moment it supports only one method, @ref cameraAutoDetect to open camera dialog
*
* @short DCOP interface for DigiKam
* @author Leonid Zeitlin
*/

class DCOPIface : public TQObject, public DCOPObject
{
    K_DCOP
    TQ_OBJECT

public:

    /**
     * Standard constructor.
     * @param parent Parent object reference, passed to @ref TQObject constructor
     * @param name Specifis the name of the object, passed to @ref TQObject constructor
     */
    DCOPIface(TQObject *parent = 0, const char *name = 0);

    /**
     * Standard destructor
    */
    ~DCOPIface();

signals:
    
    /**
     * This signal is emitted when @ref cameraAutoDetect() is called via DCOP
     */
    void signalCameraAutoDetect();

    /**
     * This signal is emitted when @ref downloadFrom() is called via DCOP
     * @param folder the path passed tp downloadFrom earlier
     */
    void signalDownloadImages( const TQString& folder);


public:

k_dcop:
    /**
     * This method can be called via DCOP to auto-detect attached camera and show DigiKam camera dialog
     * For example, a hotplug script can call it when a USB camera is attached to the computer 
     */
    ASYNC detectCamera();

    /**
     * This method can be called via DCOP to auto-detect attached camera and 
     * show DigiKam camera dialog. For example, a hotplug script can call it 
     * when a USB camera is attached to the computer 
     */
    ASYNC downloadFrom( const TQString &folder );
};

}  // namespace Digikam

#endif // DCOPIFACE_H