KNode::ArticleWidget Class Reference

#include <articlewidget.h>

Inheritance diagram for KNode::ArticleWidget:

Public Slots
void	scrollDown ()
void	scrollNext ()
void	scrollPrior ()
void	scrollUp ()

Public Member Functions
	ArticleWidget (QWidget *parent, KXMLGUIClient *guiClient, KActionCollection *actionCollection, bool isMainViewer=false)
	~ArticleWidget ()
KNArticle::Ptr	article () const
bool	atBottom () const
void	readConfig ()
void	setArticle (KNArticle::Ptr article)
void	writeConfig ()
Public Member Functions inherited from KNJobConsumer
	KNJobConsumer ()
virtual	~KNJobConsumer ()
void	cancelJobs (boost::shared_ptr< KNJobItem > item)
void	emitJob (KNJobData *j)
void	jobDone (KNJobData *j)
bool	jobsPending () const

Static Public Member Functions
static void	articleChanged (KNArticle::Ptr article)
static void	articleLoadError (KNArticle::Ptr article, const QString &error)
static void	articleRemoved (KNArticle::Ptr article)
static bool	articleVisible (KNArticle::Ptr article)
static void	cleanup ()
static void	collectionRemoved (KNArticleCollection::Ptr coll)
static void	configChanged ()

Protected Member Functions
void	processJob (KNJobData *j)

Additional Inherited Members
Protected Attributes inherited from KNJobConsumer
QList< KNJobData * >	mJobs

Detailed Description

Widget to display a news article.

Definition at line 47 of file articlewidget.h.

Constructor & Destructor Documentation

ArticleWidget::ArticleWidget	(	QWidget *	parent,
		KXMLGUIClient *	guiClient,
		KActionCollection *	actionCollection,
		bool	isMainViewer = false
	)

Construct a new article widget.

Definition at line 88 of file articlewidget.cpp.

ArticleWidget::~ArticleWidget

(

)

Destroy the article widget.

Definition at line 134 of file articlewidget.cpp.

Member Function Documentation

KNArticle::Ptr KNode::ArticleWidget::article ( ) const

inline

returns the currently shown article

Definition at line 69 of file articlewidget.h.

void ArticleWidget::articleChanged ( KNArticle::Ptr  article )

static

notify all instances that the given article has changed

Parameters

article

The changed article.

Definition at line 1113 of file articlewidget.cpp.

void ArticleWidget::articleLoadError ( KNArticle::Ptr  article, const QString &  error  )

static

notify all instances about an error during loading the given article

Parameters

article	The article that couldn't be loaded.
error	The error message.

Definition at line 1121 of file articlewidget.cpp.

void ArticleWidget::articleRemoved ( KNArticle::Ptr  article )

static

notify all instances that the given article has been removed

Parameters

article

The removed article.

Definition at line 1105 of file articlewidget.cpp.

bool ArticleWidget::articleVisible ( KNArticle::Ptr  article )

static

check whether the given article is displayed in any instance

Parameters

article

The article to check.

Definition at line 1096 of file articlewidget.cpp.

bool ArticleWidget::atBottom

(

)

const

checks whether the readers is scrolled down to the bottom

Definition at line 1145 of file articlewidget.cpp.

void ArticleWidget::cleanup ( )

static

cleanup all instances

Definition at line 1137 of file articlewidget.cpp.

void ArticleWidget::collectionRemoved ( KNArticleCollection::Ptr  coll )

static

notify all instances that the given collection has been removed

Parameters

coll	The removed article collection (a group or a folder).

Definition at line 1129 of file articlewidget.cpp.

void ArticleWidget::configChanged ( )

static

notify all instances about a config change

Definition at line 1087 of file articlewidget.cpp.

void ArticleWidget::processJob ( KNJobData *  j )

protectedvirtual

process download jobs for view source action

Reimplemented from KNJobConsumer.

Definition at line 1067 of file articlewidget.cpp.

void ArticleWidget::readConfig

(

)

read config settings

Definition at line 337 of file articlewidget.cpp.

void ArticleWidget::scrollDown ( )

slot

scroll down by one line

Definition at line 1156 of file articlewidget.cpp.

void ArticleWidget::scrollNext ( )

slot

scroll down by one page

Definition at line 1166 of file articlewidget.cpp.

void ArticleWidget::scrollPrior ( )

slot

scroll up by one page

Definition at line 1161 of file articlewidget.cpp.

void ArticleWidget::scrollUp ( )

slot

scroll up by one line

Definition at line 1151 of file articlewidget.cpp.

void ArticleWidget::setArticle

(

KNArticle::Ptr

article

)

display the given article

Parameters

article

The article to display.

Definition at line 379 of file articlewidget.cpp.

void ArticleWidget::writeConfig

(

)

write config settings (call only for the main viewer)

Definition at line 362 of file articlewidget.cpp.

---

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

• articlewidget.h
• articlewidget.cpp