KNode::ArticleWindow Class Reference

#include <knarticlewindow.h>

Inheritance diagram for KNode::ArticleWindow:

Public Types
typedef QList < KNode::ArticleWindow * >	List

Public Member Functions
	ArticleWindow (KNArticle::Ptr art)
	~ArticleWindow ()
ArticleWidget *	articleWidget () const

Static Public Member Functions
static bool	closeAllWindowsForArticle (KNArticle::Ptr art, bool force=true)
static bool	closeAllWindowsForCollection (KNArticleCollection::Ptr col, bool force=true)
static bool	raiseWindowForArticle (KNArticle::Ptr art)
static bool	raiseWindowForArticle (const QByteArray &mid)

Protected Attributes
ArticleWidget *	mArticleWidget

Static Protected Attributes
static List	mInstances

Detailed Description

A stand-alone article viewer window.

Definition at line 31 of file knarticlewindow.h.

Member Typedef Documentation

typedef QList<KNode::ArticleWindow*> KNode::ArticleWindow::List

List of article windows.

Definition at line 46 of file knarticlewindow.h.

Constructor & Destructor Documentation

ArticleWindow::ArticleWindow ( KNArticle::Ptr  art )

explicit

Create a new article window.

Parameters

art	The article to show in this window.

Definition at line 92 of file knarticlewindow.cpp.

ArticleWindow::~ArticleWindow

(

)

Destroy this article viewer window.

Definition at line 126 of file knarticlewindow.cpp.

Member Function Documentation

ArticleWidget* KNode::ArticleWindow::articleWidget ( ) const

inline

Returns the article widget of this window.

Definition at line 43 of file knarticlewindow.h.

bool ArticleWindow::closeAllWindowsForArticle ( KNArticle::Ptr  art, bool  force = true  )

static

Clise all windows showing the given article.

Parameters

art	Close all windows showing this article.
force	Really close the windows.

Returns

true if all windows have been closed.

Definition at line 48 of file knarticlewindow.cpp.

bool ArticleWindow::closeAllWindowsForCollection ( KNArticleCollection::Ptr  col, bool  force = true  )

static

Close all article windows showing articles from the given collection.

Parameters

col	The article collection (folder/group).
force	Really close the windows.

Returns

true if all windows have been closed.

Definition at line 34 of file knarticlewindow.cpp.

bool ArticleWindow::raiseWindowForArticle ( KNArticle::Ptr  art )

static

Raise the article window for the given article.

Parameters

art	The article.

Returns

false if no article window was found.

Definition at line 62 of file knarticlewindow.cpp.

bool ArticleWindow::raiseWindowForArticle ( const QByteArray &  mid )

static

Raise the article window showing a specific article.

Parameters

mid	Message-ID of the article.

Returns

false if no article was found.

Definition at line 75 of file knarticlewindow.cpp.

Member Data Documentation

ArticleWidget* KNode::ArticleWindow::mArticleWidget

protected

The article widget of this window.

Definition at line 73 of file knarticlewindow.h.

QList< KNode::ArticleWindow * > ArticleWindow::mInstances

staticprotected

List of all article windows.

Definition at line 75 of file knarticlewindow.h.

---

The documentation for this class was generated from the following files:

• knarticlewindow.h
• knarticlewindow.cpp