File indexing completed on 2024-04-14 04:45:10

 /*
     SPDX-FileCopyrightText: 2010 Michal Malek <michalm@jabster.pl>
     SPDX-FileCopyrightText: 1998-2007 Sebastian Trueg <trueg@k3b.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #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