diff options
Diffstat (limited to 'akregator/src/akregator_view.h')
| -rw-r--r-- | akregator/src/akregator_view.h | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/akregator/src/akregator_view.h b/akregator/src/akregator_view.h new file mode 100644 index 00000000..599f8cfd --- /dev/null +++ b/akregator/src/akregator_view.h @@ -0,0 +1,343 @@ +/* + This file is part of Akregator. + + Copyright (C) 2004 Stanislav Karchebny <Stanislav.Karchebny@kdemail.net> + 2004 Sashmit Bhaduri <smt@vfemail.net> + 2005 Frank Osterfeld <frank.osterfeld at kdemail.net> + + 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. + + As a special exception, permission is given to link this program + with any edition of Qt, and distribute the resulting executable, + without including the source code for Qt in the source distribution. +*/ + +#ifndef _AKREGATORVIEW_H_ +#define _AKREGATORVIEW_H_ + +#include <qpixmap.h> +#include <qwidget.h> + +#include <kurl.h> + +#include "akregator_run.h" +#include "feed.h" + +class QSplitter; +class QDomDocument; +class QDomElement; +class QHBox; +class QToolButton; +class QListViewItem; +class KComboBox; +class KConfig; +class KFileItem; +class KLineEdit; +class KListView; +class KListViewItem; +class KTabWidget; +class Viewer; + +namespace KIO { + + class Job; +} + +namespace Akregator { + + class AboutPageViewer; + class ActionManagerImpl; + class ArticleMatcher; + class ArticleListView; + class ArticleViewer; + class BrowserRun; + class Folder; + class FeedList; + class Frame; + class NodeListView; + class ListTabWidget; + class Part; + class SearchBar; + class TabWidget; + class Tag; + class TagNodeList; + + /** + * This is the main widget of the view, containing tree view, article list, viewer etc. + */ + class View : public QWidget + { + Q_OBJECT + public: + + /** constructor + @param part the Akregator::Part which contains this widget + @param parent parent widget + @param Actionmanager for this view + @param name the name of the widget (@ref QWidget ) + */ + View(Akregator::Part *part, QWidget *parent, ActionManagerImpl* actionManager, const char* name); + + /** destructor. Note that cleanups should be done in + slotOnShutdown(), so we don't risk accessing self-deleting objects after deletion. */ + ~View(); + + /** saves settings. Make sure that the Settings singleton is not destroyed yet when saveSettings is called */ + void saveSettings(); + + void slotSettingsChanged(); + + /** Adds the feeds in @c doc to the "Imported Folder" + @param doc the DOM tree (OPML) of the feeds to import */ + bool importFeeds(const QDomDocument& doc); + + /** Parse OPML presentation of feeds and read in articles archive, if present. If @c parent is @c NULL, the current + feed list is replaced by the parsed one + @param doc QDomDocument generated from OPML + @param parent The parent group the new nodes */ + bool loadFeeds(const QDomDocument& doc, Folder* parent = 0); + + /** + @return the displayed Feed List in OPML format + */ + QDomDocument feedListToOPML(); + + /** + Add a feed to a group. + @param url The URL of the feed to add. + @param group The name of the folder into which the feed is added. + If the group does not exist, it is created. The feed is added as the last member of the group. + */ + void addFeedToGroup(const QString& url, const QString& group); + + /** session management **/ + virtual void readProperties(KConfig* config); + virtual void saveProperties(KConfig* config); + + Frame* currentFrame() const { return m_currentFrame; } + + signals: + /** emitted when the unread count of "All Feeds" was changed */ + void signalUnreadCountChanged(int); + + void setWindowCaption(const QString&); + void setStatusBarText(const QString&); + void setProgress(int); + void signalStarted(KIO::Job*); + void signalCompleted(); + void signalCanceled(const QString&); + + public slots: + + void slotOnShutdown(); + + /** selected tree node has changed */ + void slotNodeSelected(TreeNode* node); + + /** the article selection has changed */ + void slotArticleSelected(const Article&); + + /** Shows requested popup menu for feed tree */ + void slotFeedTreeContextMenu(KListView*, TreeNode*, const QPoint&); + + /** emits @ref signalUnreadCountChanged(int) */ + void slotSetTotalUnread(); + + /** special behaviour in article list view (TODO: move code there?) */ + void slotMouseButtonPressed(int button, const Article& article, const QPoint & pos, int c); + + /** opens article of @c item in external browser */ + void slotOpenArticleExternal(const Article& article, const QPoint&, int); + + /** opens the current article (currentItem) in external browser + TODO: use selected instead of current? */ + void slotOpenCurrentArticleExternal(); + + /** opens the current article (currentItem) in background tab + TODO: use selected instead of current? */ + void slotOpenCurrentArticleBackgroundTab(); + + /** opens current article in new tab, background/foreground depends on settings TODO: use selected instead of current? */ + void slotOpenCurrentArticle(); + + /** copies the link of current article to clipboard + */ + void slotCopyLinkAddress(); + + /** opens a page viewer in a new tab and loads an URL + @param url the url to load + @param background whether the tab should be opened in the background or in the foreground (activated after creation) */ + void slotOpenNewTab(const KURL& url, bool background = false); + + /** called when another part/frame is activated. Updates progress bar, caption etc. accordingly + @param f the activated frame */ + void slotFrameChanged(Frame *f); + + /** sets the window caption after a frame change */ + void slotCaptionChanged(const QString &); + + /** called when URLs are dropped into the tree view */ + void slotFeedURLDropped (KURL::List &urls, TreeNode* after, Folder *parent); + + /** displays a URL in the status bar when the user moves the mouse over a link */ + void slotMouseOverInfo(const KFileItem *kifi); + + /** sets the status bar text to a given string */ + void slotStatusText(const QString &); + + void slotStarted(); + void slotCanceled(const QString &); + void slotCompleted(); + void slotLoadingProgress(int); + + void slotFetchingStarted(); + void slotFetchingStopped(); + + + /** Feed has been fetched, populate article view if needed and update counters. */ + void slotFeedFetched(Feed *); + + /** adds a new feed to the feed tree */ + void slotFeedAdd(); + /** adds a feed group to the feed tree */ + void slotFeedAddGroup(); + /** removes the currently selected feed (ask for confirmation)*/ + void slotFeedRemove(); + /** calls the properties dialog for feeds, starts renaming for feed groups */ + void slotFeedModify(); + /** fetches the currently selected feed */ + void slotFetchCurrentFeed(); + /** starts fetching of all feeds in the tree */ + void slotFetchAllFeeds(); + /** marks all articles in the currently selected feed as read */ + void slotMarkAllRead(); + /** marks all articles in all feeds in the tree as read */ + void slotMarkAllFeedsRead(); + /** opens the homepage of the currently selected feed */ + void slotOpenHomepage(); + + /** toggles the keep flag of the currently selected article */ + void slotArticleToggleKeepFlag(bool enabled); + /** deletes the currently selected article */ + void slotArticleDelete(); + /** marks the currently selected article as read */ + void slotSetSelectedArticleRead(); + /** marks the currently selected article as unread */ + void slotSetSelectedArticleUnread(); + /** marks the currently selected article as new */ + void slotSetSelectedArticleNew(); + /** marks the currenctly selected article as read after a user-set delay */ + void slotSetCurrentArticleReadDelayed(); + + /** reads the currently selected articles using KTTSD */ + void slotTextToSpeechRequest(); + + void slotAssignTag(const Tag& tag, bool assign); + //void slotRemoveTag(const Tag& tag); + void slotNewTag(); + void slotTagCreated(const Tag& tag); + void slotTagRemoved(const Tag& tag); + + /** switches view mode to normal view */ + void slotNormalView(); + /** switches view mode to widescreen view */ + void slotWidescreenView(); + /** switches view mode to combined view */ + void slotCombinedView(); + /** toggles the visibility of the filter bar */ + void slotToggleShowQuickFilter(); + + /** selects the previous unread article in the article list */ + void slotPrevUnreadArticle(); + /** selects the next unread article in the article list */ + void slotNextUnreadArticle(); + + void slotMoveCurrentNodeUp(); + void slotMoveCurrentNodeDown(); + void slotMoveCurrentNodeLeft(); + void slotMoveCurrentNodeRight(); + + protected: + + void addFeed(const QString& url, TreeNode* after, Folder* parent, bool autoExec = true); + + void connectToFeedList(FeedList* feedList); + void disconnectFromFeedList(FeedList* feedList); + + void updateTagActions(); + + protected slots: + + void connectFrame(Frame *); + + void setTabIcon(const QPixmap&); + + void slotDoIntervalFetches(); + void slotDeleteExpiredArticles(); + + /** HACK: receives signal from browserrun when the browserrun detects an HTML mimetype and actually loads the page TODO: Remove for KDE 4.0 */ + void slotOpenURLReply(const KURL& url, Akregator::Viewer* currentViewer, Akregator::BrowserRun::OpeningMode mode); + + /** HACK: part of the url opening hack for 3.5. called when a viewer emits urlClicked(). TODO: Remove for KDE4 */ + void slotUrlClickedInViewer(const KURL& url, Viewer* viewer, bool newTab, bool background); + + void slotOpenURL(const KURL& url, Akregator::Viewer* currentViewer, Akregator::BrowserRun::OpeningMode mode); + + public: // compat with KDE-3.x assertions, remove for KDE 4 +// private: + + enum ViewMode { NormalView=0, WidescreenView, CombinedView }; + + FeedList* m_feedList; + TagNodeList* m_tagNodeList; + NodeListView* m_feedListView; + NodeListView* m_tagNodeListView; + ArticleListView *m_articleList; + ArticleViewer *m_articleViewer; + TabWidget *m_tabs; + + QWidget *m_mainTab; + Frame *m_mainFrame; + Frame *m_currentFrame; + + SearchBar* m_searchBar; + + QSplitter *m_articleSplitter; + QSplitter *m_horizontalSplitter; + + ListTabWidget* m_listTabWidget; + Akregator::Part *m_part; + ViewMode m_viewMode; + + QTimer *m_fetchTimer; + QTimer* m_expiryTimer; + QTimer *m_markReadTimer; + + bool m_shuttingDown; + bool m_displayingAboutPage; + + ActionManagerImpl* m_actionManager; + + QPixmap m_keepFlagIcon; + friend class EditNodePropertiesVisitor; + class EditNodePropertiesVisitor; + EditNodePropertiesVisitor* m_editNodePropertiesVisitor; + friend class DeleteNodeVisitor; + class DeleteNodeVisitor; + DeleteNodeVisitor* m_deleteNodeVisitor; + }; +} + +#endif // _AKREGATORVIEW_H_ |