MHelpButton Class Reference

MHelpButton is a button offering help for the user with a common look. More...

Inherits MButton.

List of all members.

Public Member Functions
	MHelpButton (const QString &pageID, QGraphicsItem *parent=0)
	~MHelpButton ()
QString	pageID () const
void	setPageID (const QString &id)
Properties
QString	pageID

---

Detailed Description

MHelpButton is a button offering help for the user with a common look.

Overview

MHelpButton offers a help button. If the user presses it, it will open the current userguide application at the page specified by pageID().

See also:

setPageID about how to specify the page.

---

Constructor & Destructor Documentation

MHelpButton::MHelpButton	(	const QString &	pageID,
		QGraphicsItem *	parent = 0
	)

Constructs a help button.

Constructs a help button with a pageID.

Parameters:

	pageID	The id of the page to be opened when the button is clicked.
	parent	The parent of the widget.

See also:

setPageID about how to specify the page.

MHelpButton::~MHelpButton

(

)

Destroys the help button.

---

Member Function Documentation

QString MHelpButton::pageID

(

)

const

Gets the pageID.

See also:

setPageID.

void MHelpButton::setPageID

(

const QString &

id

)

Sets the pageID.

The pageID is the id of the page where userguide will be opened at when the user clicks on the button.

The id of a page is its relative path from the locale dependant content directory, for example if the page resides under:

 /usr/share/userguide/content/en/dir/page.cfg

then its id is:

 dir/page.cfg

See also:

pageID

---

Property Documentation

QString MHelpButton::pageID [read, write]