You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdewebdev/quanta/project/project.h

222 lines
6.9 KiB

/***********************************************************************
project.h - description
-------------------
begin : Thu Mar 16 2000
copyright : (C) 2000 by Yacovlev Alexander & Dmitry Poplavsky <pdima@mail.univ.kiev.ua>
(C) 2001-2005 by Andras Mantia <amantia@kde.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. *
* *
***************************************************************************/
#ifndef PROJECT_H
#define PROJECT_H
#include <tqobject.h>
#include "projecturl.h"
class TQDom;
class ProjectPrivate;
class ProjectList;
namespace KTextEditor{
class MarkInterface;
class ViewCursorInterface;
}
struct EventAction;
typedef TQMap<TQString, TQValueList<EventAction> > EventActions;
/**project
*@author Yacovlev Alexander & Dmitry Poplavsky & Andras Mantia & Jens Herden
*/
class TDEConfig;
class KMainWindow;
struct TeamMember {
TQString name;
TQString email;
TQString nickName;
TQString task;
};
struct SubProject {
TQString name;
TQString location;
};
class Project : public TQObject {
Q_OBJECT
friend class ProjectPrivate; // need this because I use the signals
public:
/**
* since this class is a singleton you must use this function to access it
*
* the parameter is only used at the first call to create the class
*
*/
static Project* const ref(KMainWindow *parent = 0L)
{
static Project *m_ref;
if (!m_ref) m_ref = new Project(parent);
return m_ref;
}
~Project();
bool hasProject();
TQString projectName();
TQStringList fileNameList();
KURL::List files();
void insertFile( const KURL& nameURL, bool repaint );
void readConfig(TDEConfig *);
/** loads the last project again if reload == true
but checks in any case if there is a left over project from a crash
*/
void loadLastProject(bool reload);
/** Returns the relative url with the prefix inserted. */
KURL urlWithPrefix(const KURL& url);
bool contains(const KURL &url);
/** Read property of TQString defaultDTD. */
const TQString& defaultDTD();
const TQString& defaultEncoding();
/** Returns the project's base URL if it exists,
* the HOME dir if there is no project and no opened document
* (or the current opened document was not saved yet),
* and the base URL of the opened document, if it is saved somewhere.
*/
KURL projectBaseURL();
KURL documentFolderForURL(const KURL &url);
/** Saves the password for entry into a list. Stores on disc if store == true */
void savePassword(const TQString& entry, const TQString& passwd, bool store);
/** Returns the saved password for entry */
TQString password(const TQString &entry);
bool passwordSaved(const TQString &entry);
TQDomDocument *dom();
TQDomDocument *sessionDom();
TQString debuggerClient();
bool debuggerPersistentBreakpoints();
bool debuggerPersistentWatches();
bool keepPasswd;
TQString email();
KURL templateURL();
KURL toolbarURL();
EventActions* events();
/**
* Get the nickname of the current user (you)
* @return the nickname
*/
TQString yourself();
/**
* Get the roles of the current user in the form "role:task".
* Examples: "team leader", "project leader:subprojectname", "task leader:taskname".
* @return the roles (in lowercase)
*/
TQStringList yourRoles();
TeamMember teamLeader();
TeamMember subprojectLeader(const TQString &name);
TeamMember taskLeader(const TQString &name);
TQValueList<TeamMember> simpleMembers();
TQString mailingList();
TQValueList<SubProject>* subprojects();
TQStringList tasks();
TQMap<TQString, TeamMember> allMembers();
bool eventsEnabled();
void setProjectToolbarVisible(bool visible) {m_projectToolbarVisible = visible;}
/** Called when an url was moved inside the project with drag &drop */
void urlMoved(const KURL& srcURL, const KURL &destURL);
/**
test if application can close
@return true if close is possible
*/
bool queryClose();
/** Saves the bookmarks for the url into the project file */
void saveBookmarks(const KURL &url, KTextEditor::MarkInterface *markIf);
/** Loads the bookmarks for the url from the project file and sets them in the view*/
void loadBookmarks(const KURL &url, KTextEditor::MarkInterface *markIf);
void saveCursorPosition(const KURL &url, KTextEditor::ViewCursorInterface *viewCursorIf);
void loadCursorPosition(const KURL &url, KTextEditor::ViewCursorInterface *viewCursorIf);
public slots:
void slotOpenProject(const KURL&);
void slotOptions();
void slotUpload();
void slotUploadURL(const KURL &urlToUpload, const TQString &profileName, bool quickUpload, bool markOnly);
void slotAddDirectory(const KURL& dirURL, bool showDlg = true);
void slotInsertFile(const KURL& url);
void slotInsertFilesAfterCopying(const KURL::List& a_url);
/** if somewhere something was renamed */
void slotRenamed(const KURL& oldURL, const KURL& newURL);
void slotRemove(const KURL& urlToRemove);
void slotGetMessages(const TQString&);
void slotRescanPrjDir();
void slotFileDescChanged(const KURL& url, const TQString& desc);
void slotUploadStatusChanged(const KURL& url, int status);
void slotChangeDocumentFolderStatus(const KURL& url, bool status);
void slotReloadProjectDocs();
void slotShowProjectToolbar(bool show);
void setModified(bool b = true);
signals:
void openFile( const KURL&, const TQString& );
void openFiles( const KURL::List&, const TQString& );
void closeFile( const KURL&);
void closeFiles();
void reloadTree(ProjectList *, bool, const TQStringList &);
void messages(const TQString& );
void enableMessageWidget();
void newStatus();
void statusMsg(const TQString &);
/** No descriptions */
void newProjectLoaded(const TQString &, const KURL &, const KURL &);
void reloadProjectDocs();
void hideSplash();
void addProjectDoc(const KURL &);
void getUserToolbarFiles(KURL::List *);
void loadToolbarFile(const KURL &);
/** ask for the tree status for saving in project */
void getTreeStatus(TQStringList *);
void eventHappened(const TQString&, const TQString&, const TQString& );
private:
/** The constructor is privat because we use singleton patter.
* If you need the class use Project::ref() for
* construction and reference
*/
Project(KMainWindow *parent);
ProjectPrivate *d;
bool m_projectToolbarVisible;
};
#endif