QtxMenu Class Reference

The class QtxMenu represents the popup menu with the title. More...

#include <QtxMenu.h>

Inheritance diagram for QtxMenu:

Classes
class	Title
	Popup menu title item. More...

Public Types
enum	TitleMode { TitleAuto , TitleOn , TitleOff }
	Popup menu title mode. More...

Public Slots
virtual void	setVisible (bool)
	Customize show/hide menu operation. More...

Public Member Functions
	QtxMenu (QWidget *=0)
	Constructor. More...
virtual	~QtxMenu ()
	Destructor. More...
QIcon	titleIcon () const
	Get title icon. More...
QString	titleText () const
	Get title menu text. More...
TitleMode	titleMode () const
	Get title item display mode. More...
Qt::Alignment	titleAlignment () const
	Get title alignment flags. More...
virtual void	setTitleIcon (const QIcon &)
	Set title icon. More...
virtual void	setTitleText (const QString &)
	Set title menu text. More...
virtual void	setTitleMode (const TitleMode)
	Set title item display mode. More...
virtual void	setTitleAlignment (const Qt::Alignment)
	Set title alignment flags. More...
virtual void	addGroup (const QString &)
	Append group title to the end of the menu. More...
virtual void	addGroup (const QIcon &, const QString &)
	Append group title to the end of the menu. More...

Private Member Functions
void	updateTitle ()
	Update title item. More...
void	insertTitle ()
	Insert title item to the popup menu. More...
void	removeTitle ()
	Remove title item from the popup menu. More...

Private Attributes
TitleMode	myMode
Title *	myTitle
QWidgetAction *	myAction

Detailed Description

The class QtxMenu represents the popup menu with the title.

The title for the popup menu can be set via setTitleText() method. In addition, title item can contain the icon, which can be set using setTitleIcon() method. Current title text and icon can be retrieved with titleText() and titleIcon() methods.

The title text alignment flags can be changed using setTitleAlignment() method and retrieved with titleAlignment() method.

By default, QtxMenu::TitleAuto mode is used. In this mode, the title item is shown only if it is not empty. To show title always (even empty), pass QtxMenu::TitleOn to the setTitleMode() method. To hide the title, use setTitleMode() method with QtxMenu::TitleOff parameter.

Member Enumeration Documentation

TitleMode

enum QtxMenu::TitleMode

Popup menu title mode.

Enumerator
TitleAuto	auto mode
TitleOn	always on (display title)
TitleOff	always off (do not display title)

Constructor & Destructor Documentation

QtxMenu()

QtxMenu::QtxMenu

(

QWidget *

parent = 0

)

Constructor.

Parameters

parent

parent widget

References myAction, and myTitle.

~QtxMenu()

QtxMenu::~QtxMenu ( )

virtual

Destructor.

Member Function Documentation

addGroup() [1/2]

void QtxMenu::addGroup ( const QIcon &  icon, const QString &  text  )

virtual

Append group title to the end of the menu.

Parameters

icon	group title's icon
text	group title's text

References QtxMenu::Title::setIcon(), and QtxMenu::Title::setText().

addGroup() [2/2]

void QtxMenu::addGroup ( const QString &  text )

virtual

Append group title to the end of the menu.

Parameters

text	group title's text

References QtxMenu::Title::setText().

insertTitle()

void QtxMenu::insertTitle ( )

private

Insert title item to the popup menu.

References myAction, TitleAuto, titleMode(), TitleOff, and titleText().

removeTitle()

void QtxMenu::removeTitle ( )

private

Remove title item from the popup menu.

References myAction.

setTitleAlignment()

void QtxMenu::setTitleAlignment ( const Qt::Alignment  a )

virtual

Set title alignment flags.

Parameters

a	title alignment flags

References myTitle, QtxMenu::Title::setAlignment(), titleAlignment(), and updateTitle().

setTitleIcon()

void QtxMenu::setTitleIcon ( const QIcon &  ico )

virtual

Set title icon.

Parameters

ico	title item icon

References myTitle, QtxMenu::Title::setIcon(), and updateTitle().

setTitleMode()

void QtxMenu::setTitleMode ( const  TitleMode )

virtual

Set title item display mode.

Parameters

m	popup menu title display mode (QtxMenu::TitleMode)

References myMode, and updateTitle().

setTitleText()

void QtxMenu::setTitleText ( const QString &  txt )

virtual

Set title menu text.

Parameters

txt	menu text to be used for the title item

References myTitle, QtxMenu::Title::setText(), titleText(), and updateTitle().

setVisible

void QtxMenu::setVisible ( bool  on )

virtualslot

Customize show/hide menu operation.

Parameters

on	new popup menu visibility state

References insertTitle(), and removeTitle().

titleAlignment()

Qt::Alignment QtxMenu::titleAlignment

(

)

const

Get title alignment flags.

Returns

title alignment flags

References QtxMenu::Title::alignment(), and myTitle.

titleIcon()

QIcon QtxMenu::titleIcon

(

)

const

Get title icon.

Returns

title item icon

References QtxMenu::Title::icon(), and myTitle.

titleMode()

QtxMenu::TitleMode QtxMenu::titleMode

(

)

const

Get title item display mode.

Returns

popup menu title display mode (QtxMenu::TitleMode)

References myMode.

titleText()

QString QtxMenu::titleText

(

)

const

Get title menu text.

Returns

menu text for the title item

References myTitle, and QtxMenu::Title::text().

updateTitle()

void QtxMenu::updateTitle ( )

private

Update title item.

References insertTitle(), myAction, and removeTitle().

Member Data Documentation

myAction

QWidgetAction* QtxMenu::myAction

private

myMode

TitleMode QtxMenu::myMode

private

myTitle

Title* QtxMenu::myTitle

private

---

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

• src/Qtx/QtxMenu.h
• src/Qtx/QtxMenu.cxx