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
97
98
99
100
101
102
103
104
105
106
107
|
/*
*
* Copyright (C) 2003 Sebastian Trueg <trueg@k3b.org>
* Copyright (C) 2010 Michal Malek <michalm@jabster.pl>
*
* This file is part of the K3b project.
* Copyright (C) 1998-2007 Sebastian Trueg <trueg@k3b.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.
* See the file "COPYING" for the exact licensing terms.
*/
#ifndef _K3B_DATA_PROJECT_INTERFACE_H_
#define _K3B_DATA_PROJECT_INTERFACE_H_
#include "k3bprojectinterface.h"
#include <QStringList>
namespace K3b {
class DataDoc;
class DataProjectInterface : public ProjectInterface
{
Q_OBJECT
Q_CLASSINFO( "D-Bus Interface", "org.k3b.DataProject" )
public:
explicit DataProjectInterface( DataDoc* doc, const QString& dbusPath = QString() );
public Q_SLOTS:
/**
* Create a new folder in the root of the doc.
* This is the same as calling createFolder( name, "/" )
*/
bool createFolder( const QString& name );
/**
* Create a new folder with name @p name in the folder with the
* absolute path @p dir.
*
* \return true if the folder was created successfully, false if
* an item with the same name already exists or the dir
* directory could not be found.
*
* Example: createFolder( "test", "/foo/bar" ) will create the
* folder /foo/bar/test.
*/
bool createFolder( const QString& name, const QString& dir );
/**
* Add urls to a specific folder in the project.
*
* Example: addUrl( "test.txt", "/foo/bar" ) will add the file test.txt
* to folder /foo/bar.
*/
void addUrl( const QString& url, const QString& dir );
void addUrls( const QStringList& urls, const QString& dir );
/**
* Remove an item
* \return true if the item was successfully removed.
*/
bool removeItem( const QString& path );
/**
* Rename an item
* \return true if the item was successfully renamed, false if
* no item could be found at \p path, \p newName is empty,
* or the item cannot be renamed for some reason.
*/
bool renameItem( const QString& path, const QString& newName );
/**
* Set the volume ID of the data project. This is the name shown by Windows
* when the CD is inserted.
*/
void setVolumeID( const QString& id );
/**
* \return true if the specified path exists in the project and it is a folder.
*/
bool isFolder( const QString& path ) const;
/**
* \return the names of the child elements of the item determined by path.
*/
QStringList children( const QString& path ) const;
/**
* Set the sort weight of an item
* \return false if the item at \p could not be found.
*/
bool setSortWeight( const QString& path, long weight ) const;
private:
DataDoc* m_dataDoc;
};
}
#endif
|