diff options
Diffstat (limited to 'libktorrent/interfaces/guiinterface.h')
-rw-r--r-- | libktorrent/interfaces/guiinterface.h | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/libktorrent/interfaces/guiinterface.h b/libktorrent/interfaces/guiinterface.h new file mode 100644 index 0000000..a263bb6 --- /dev/null +++ b/libktorrent/interfaces/guiinterface.h @@ -0,0 +1,218 @@ +/*************************************************************************** + * Copyright (C) 2005 by Joris Guisson * + * joris.guisson@gmail.com * + * * + * 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. * + * * + * 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. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * + ***************************************************************************/ +#ifndef KTGUIINTERFACE_H +#define KTGUIINTERFACE_H + +#include <qptrlist.h> + +class QWidget; +class QIconSet; +class QString; +class KToolBar; +class KProgress; + +namespace kt +{ + class PrefPageInterface; + class Plugin; + class TorrentInterface; + class GUIInterface; + + enum Position + { + LEFT, ///< New widgets will be added to the left of the old + RIGHT, ///< New widgets will be added to the right of the old + ABOVE, ///< New widgets will be added above the old + BELOW ///< New widgets will be added below the old + }; + + /** + * Small interface for classes who want to know when + * current torrent in the gui changes. + */ + class ViewListener + { + public: + ViewListener() {} + virtual ~ViewListener() {} + + virtual void currentTorrentChanged(TorrentInterface* tc) = 0; + }; + + /** + * Plugins wanting to add closeable tabs, should implement this interface. + * That way they can be notified of close requests. + * Not providing this interface in addTabPage means the tab cannot be closed. + */ + class CloseTabListener + { + public: + /// By default all tabs can be closed, but this can be overridden + virtual bool closeAllowed(QWidget* ) {return true;} + + /// THe close button was pressed for this tab, please remove it from the GUI + virtual void tabCloseRequest(kt::GUIInterface* gui,QWidget* tab) = 0; + }; + + /** + * @author Joris Guisson + * @brief Interface to modify the GUI + * + * This interface allows plugins and others to modify the GUI. + */ + class GUIInterface + { + QPtrList<ViewListener> listeners; + public: + GUIInterface(); + virtual ~GUIInterface(); + + + /// Add a view listener. + void addViewListener(ViewListener* vl); + + /// Remove a view listener + void removeViewListener(ViewListener* vl); + + /// Add a progress bar tot the status bar, if one is already present this will fail and return 0 + virtual KProgress* addProgressBarToStatusBar() = 0; + + /// Remove the progress bar from the status bar + virtual void removeProgressBarFromStatusBar(KProgress* p) = 0; + + /** + * Add a new tab page to the GUI + * @param page The widget + * @param icon Icon for the tab + * @param caption Text on the tab + * @param ctl For closeable tabs this pointer should be set + */ + virtual void addTabPage(QWidget* page,const QIconSet & icon, + const QString & caption,CloseTabListener* ctl = 0) = 0; + + /** + * Remove a tab page, does nothing if the page + * isn't added. Does not delete the widget. + * @param page The page + */ + virtual void removeTabPage(QWidget* page) = 0; + + /** + * Add a page to the preference dialog. + * @param page The page + */ + virtual void addPrefPage(PrefPageInterface* page) = 0; + + + /** + * Remove a page from the preference dialog. + * @param page The page + */ + virtual void removePrefPage(PrefPageInterface* page) = 0; + + /** + * Change the statusbar message. + * @param msg The new message + */ + virtual void changeStatusbar(const QString& msg) = 0; + + /** + * Merge the GUI of a plugin. + * @param p The Plugin + */ + virtual void mergePluginGui(Plugin* p) = 0; + + /** + * Remove the GUI of a plugin. + * @param p The Plugin + */ + virtual void removePluginGui(Plugin* p) = 0; + + /** + * Embed a widget in the view in the mainview. + * The view and the new widget will be separated by a separator. + * @param w The widget + * @param pos How the widget will be positioned against the already present widgets + */ + virtual void addWidgetInView(QWidget* w,Position pos) = 0; + + /** + * Remove a widget added with addWidgetInView. + * The widget will be reparented to 0. + * @param w The widget + */ + virtual void removeWidgetFromView(QWidget* w) = 0; + + /** + * Add a widget below the view. + * @param w The widget + * @param icon Name of icon to use + * @param caption The caption to use + */ + virtual void addWidgetBelowView(QWidget* w,const QString & icon,const QString & caption) = 0; + + /** + * Remove a widget, which was added below the view. + * @param w The widget + */ + virtual void removeWidgetBelowView(QWidget* w) = 0; + + enum ToolDock + { + DOCK_LEFT, + DOCK_RIGHT, + DOCK_BOTTOM + }; + + /** + * Add a tool widget. + * @param w The widget + * @param icon Name of icon to use + * @param caption The caption to use + * @param dock Where to dock the widget + */ + virtual void addToolWidget(QWidget* w,const QString & icon,const QString & caption,ToolDock dock) = 0; + + /** + * Remove a tool widget. + * @param w The widget + */ + virtual void removeToolWidget(QWidget* w) = 0; + + /// Get the current torrent. + virtual const TorrentInterface* getCurrentTorrent() const = 0; + + /// Add a toolbar + virtual KToolBar* addToolBar(const char* name) = 0; + + /// Remove a toolbar + virtual void removeToolBar(KToolBar* tb) = 0; + + protected: + /** + * Notifies all view listeners of the change in the current downloading TorrentInterface + * @param tc Pointer to current TorrentInterface + */ + void notifyViewListeners(TorrentInterface* tc); + }; + +} + +#endif |