Akregator::Frame Class Reference

#include <frame.h>

Inheritance diagram for Akregator::Frame:

Public Types
enum	State { Idle, Started, Completed, Canceled }

Public Slots
virtual void	slotHistoryBack ()
virtual void	slotHistoryBackAboutToShow ()
virtual void	slotHistoryForward ()
virtual void	slotHistoryForwardAboutToShow ()
virtual void	slotReload ()
void	slotSetCanceled (const QString &)
void	slotSetCaption (const QString &)
void	slotSetCompleted ()
void	slotSetProgress (int)
void	slotSetStarted ()
void	slotSetState (State)
void	slotSetStatusText (const QString &)
void	slotSetTitle (const QString &)
virtual void	slotStop ()

Signals
void	signalCanceled (Akregator::Frame *, const QString &)
void	signalCanGoBackToggled (Akregator::Frame *, bool)
void	signalCanGoForwardToggled (Akregator::Frame *, bool)
void	signalCaptionChanged (Akregator::Frame *, const QString &)
void	signalCompleted (Akregator::Frame *)
void	signalIconChanged (Akregator::Frame *, const QIcon &icon)
void	signalIsLoadingToggled (Akregator::Frame *, bool)
void	signalIsReloadableToggled (Akregator::Frame *, bool)
void	signalLoadingProgress (Akregator::Frame *, int)
void	signalOpenUrlRequest (Akregator::OpenUrlRequest &request)
void	signalStarted (Akregator::Frame *)
void	signalStatusText (Akregator::Frame *, const QString &)
void	signalTitleChanged (Akregator::Frame *, const QString &)

Public Member Functions
	Frame (QWidget *parent=0)
virtual	~Frame ()
virtual bool	canGoBack () const
virtual bool	canGoForward () const
QString	caption () const
int	id () const
virtual bool	isLoading () const
virtual bool	isReloadable () const
bool	isRemovable () const
virtual void	loadConfig (const KConfigGroup &, const QString &)
virtual bool	openUrl (const OpenUrlRequest &request)=0
virtual KParts::ReadOnlyPart *	part () const =0
int	progress () const
virtual void	saveConfig (KConfigGroup &, const QString &)
State	state () const
QString	statusText () const
QString	title () const
virtual KUrl	url () const =0

Protected Member Functions
void	setRemovable (bool removable)

Protected Attributes
QString	m_caption
int	m_id
bool	m_isRemovable
bool	m_loading
int	m_progress
QString	m_progressId
KPIM::ProgressItem *	m_progressItem
State	m_state
QString	m_statusText
QString	m_title

Static Protected Attributes
static int	m_idCounter = 0

Detailed Description

Definition at line 53 of file frame.h.

Member Enumeration Documentation

enum Akregator::Frame::State

Enumerator
Idle
Started
Completed
Canceled

Definition at line 61 of file frame.h.

Constructor & Destructor Documentation

Akregator::Frame::Frame ( QWidget *  parent = 0 )

explicit

Definition at line 98 of file frame.cpp.

Akregator::Frame::~Frame ( )

virtual

Definition at line 127 of file frame.cpp.

Member Function Documentation

virtual bool Akregator::Frame::canGoBack ( ) const

inlinevirtual

returns whether it is possible to go back in the history

Reimplemented in Akregator::BrowserFrame.

Definition at line 94 of file frame.h.

virtual bool Akregator::Frame::canGoForward ( ) const

inlinevirtual

returns whether it is possible to go forward in the history

Reimplemented in Akregator::BrowserFrame.

Definition at line 89 of file frame.h.

QString Akregator::Frame::caption

(

)

const

Definition at line 146 of file frame.cpp.

int Akregator::Frame::id

(

)

const

Definition at line 112 of file frame.cpp.

bool Akregator::Frame::isLoading ( ) const

virtual

returns whether the embedded part is loading a website.

If so, it can be stopped using slotStop()

Reimplemented in Akregator::BrowserFrame.

Definition at line 51 of file frame.cpp.

virtual bool Akregator::Frame::isReloadable ( ) const

inlinevirtual

returns whether the shown content can be reloaded

Reimplemented in Akregator::BrowserFrame.

Definition at line 98 of file frame.h.

bool Akregator::Frame::isRemovable

(

)

const

Returns whether the frame can be removed from Akregator (via detach or close tab etc.) Usually all tabs but the main tab can be removed.

Default is true

Definition at line 122 of file frame.cpp.

virtual void Akregator::Frame::loadConfig ( const KConfigGroup &  , const QString &    )

inlinevirtual

Load a frame from a config file for session management.

Reimplemented in Akregator::BrowserFrame.

Definition at line 109 of file frame.h.

virtual bool Akregator::Frame::openUrl ( const OpenUrlRequest &  request )

pure virtual

Implemented in Akregator::MainFrame, and Akregator::BrowserFrame.

virtual KParts::ReadOnlyPart* Akregator::Frame::part ( ) const

pure virtual

Implemented in Akregator::MainFrame, and Akregator::BrowserFrame.

int Akregator::Frame::progress

(

)

const

Definition at line 205 of file frame.cpp.

virtual void Akregator::Frame::saveConfig ( KConfigGroup &  , const QString &    )

inlinevirtual

Save a frame to a config file for session management.

Reimplemented in Akregator::BrowserFrame.

Definition at line 114 of file frame.h.

void Akregator::Frame::setRemovable ( bool  removable )

protected

Definition at line 117 of file frame.cpp.

void Akregator::Frame::signalCanceled ( Akregator::Frame *  , const QString &    )

signal

void Akregator::Frame::signalCanGoBackToggled ( Akregator::Frame *  , bool    )

signal

void Akregator::Frame::signalCanGoForwardToggled ( Akregator::Frame *  , bool    )

signal

void Akregator::Frame::signalCaptionChanged ( Akregator::Frame *  , const QString &    )

signal

void Akregator::Frame::signalCompleted ( Akregator::Frame *  )

signal

void Akregator::Frame::signalIconChanged ( Akregator::Frame *  , const QIcon &  icon  )

signal

void Akregator::Frame::signalIsLoadingToggled ( Akregator::Frame *  , bool    )

signal

void Akregator::Frame::signalIsReloadableToggled ( Akregator::Frame *  , bool    )

signal

void Akregator::Frame::signalLoadingProgress ( Akregator::Frame *  , int    )

signal

void Akregator::Frame::signalOpenUrlRequest ( Akregator::OpenUrlRequest &  request )

signal

void Akregator::Frame::signalStarted ( Akregator::Frame *  )

signal

void Akregator::Frame::signalStatusText ( Akregator::Frame *  , const QString &    )

signal

void Akregator::Frame::signalTitleChanged ( Akregator::Frame *  , const QString &    )

signal

virtual void Akregator::Frame::slotHistoryBack ( )

inlinevirtualslot

goes a step backwards in the history, if possible.

See also canGoBack().

Definition at line 121 of file frame.h.

virtual void Akregator::Frame::slotHistoryBackAboutToShow ( )

inlinevirtualslot

Definition at line 123 of file frame.h.

virtual void Akregator::Frame::slotHistoryForward ( )

inlinevirtualslot

goes a step forward in the history, if possible.

See also canGoForward().

Definition at line 118 of file frame.h.

virtual void Akregator::Frame::slotHistoryForwardAboutToShow ( )

inlinevirtualslot

Definition at line 124 of file frame.h.

virtual void Akregator::Frame::slotReload ( )

inlinevirtualslot

reloads the current content, if possible.

See also isReloadable().

Definition at line 127 of file frame.h.

void Akregator::Frame::slotSetCanceled ( const QString &  s )

slot

Definition at line 177 of file frame.cpp.

void Akregator::Frame::slotSetCaption ( const QString &  s )

slot

Definition at line 56 of file frame.cpp.

void Akregator::Frame::slotSetCompleted ( )

slot

Definition at line 191 of file frame.cpp.

void Akregator::Frame::slotSetProgress ( int  a )

slot

Definition at line 70 of file frame.cpp.

void Akregator::Frame::slotSetStarted ( )

slot

Definition at line 156 of file frame.cpp.

void Akregator::Frame::slotSetState ( State  state )

slot

Definition at line 79 of file frame.cpp.

void Akregator::Frame::slotSetStatusText ( const QString &  s )

slot

Definition at line 63 of file frame.cpp.

void Akregator::Frame::slotSetTitle ( const QString &  s )

slot

Definition at line 42 of file frame.cpp.

void Akregator::Frame::slotStop ( )

virtualslot

Definition at line 168 of file frame.cpp.

Frame::State Akregator::Frame::state

(

)

const

Definition at line 136 of file frame.cpp.

QString Akregator::Frame::statusText

(

)

const

Definition at line 151 of file frame.cpp.

QString Akregator::Frame::title

(

)

const

Definition at line 141 of file frame.cpp.

virtual KUrl Akregator::Frame::url ( ) const

pure virtual

returns the URL of the embedded part

Implemented in Akregator::MainFrame, and Akregator::BrowserFrame.

Member Data Documentation

QString Akregator::Frame::m_caption

protected

Definition at line 162 of file frame.h.

int Akregator::Frame::m_id

protected

Definition at line 170 of file frame.h.

int Akregator::Frame::m_idCounter = 0

staticprotected

Definition at line 171 of file frame.h.

bool Akregator::Frame::m_isRemovable

protected

Definition at line 168 of file frame.h.

bool Akregator::Frame::m_loading

protected

Definition at line 169 of file frame.h.

int Akregator::Frame::m_progress

protected

Definition at line 164 of file frame.h.

QString Akregator::Frame::m_progressId

protected

Definition at line 166 of file frame.h.

KPIM::ProgressItem* Akregator::Frame::m_progressItem

protected

Definition at line 167 of file frame.h.

State Akregator::Frame::m_state

protected

Definition at line 163 of file frame.h.

QString Akregator::Frame::m_statusText

protected

Definition at line 165 of file frame.h.

QString Akregator::Frame::m_title

protected

Definition at line 161 of file frame.h.

---

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

• frame.h
• frame.cpp