MToolBar provides a container for buttons and text input field. More...

Inheritance diagram for MToolBar:

Collaboration diagram for MToolBar:

Public Member Functions
	MToolBar (QGraphicsItem *parent=0, const QString &viewType="")
virtual	~MToolBar ()
Static Public Attributes
static const MTheme::ViewType	tabType = "tab"
Protected Member Functions
	MToolBar (MToolBarPrivate dd, MWidgetModel model, QGraphicsItem *parent)

Detailed Description

MToolBar provides a container for buttons and text input field.

Overview

Toolbar acts as a container for actions. Depending upon the view attached, it either acts as a tab bar or is a container for buttons and text input field. Tab bar is a container for mutually exclusive latch-down type of buttons. It contains navigational and sorting actions that are relevant to the view but not related to any individual item displayed directly within the content area.

This class is not recommended to be used directly instead action can be added to the toolbar in the page using: action->setLocation(MAction::ToolBarLocation);

Setting up a new toolbar is quite easy. The following example shows how actions are added to a toolbar.

        MToolBar* toolbar = new MToolBar();
        MAction * iconAction = new MAction("icon-l-gallery","Pictures", this);
        iconAction->setLocation(MAction::ToolBarLocation);
        toolbar->addAction(iconAction);
        MTextEdit *entry = new MTextEdit();
        entry->setViewType("toolbar");
        MWidgetAction *action = new MWidgetAction(this);
        action->setLocation(MAction::ToolBarLocation);
        action->setWidget(entry);
        toolbar->addAction(action);

In case it is desired to add actions to tab bar view, it is necessary to set the view of the the toolbar to be of tab type. Here is how the view of the toolbar can be changed to tab bar.

        toolbar->setViewType(MToolBar::tabType);

Following demonstates how to add a tab action to the toolbar:

        MToolBar* toolbar = new MToolBar();
        MAction *action = new MAction("icon-l-gallery", NULL, this);
        action->setLocation(MAction::ToolbarLocation);
        action->setCheckable(true);
        action->setChecked(true);
        connect(action, SIGNAL(triggered()), this, SLOT(showPicture()));
        addAction(action);

Usage guidelines

The toolbar is functionally in the same role as in the application menu: it has commands that are not related specifically to any content item or button displayed within the contents of the view.
The toolbar should be utilized only if the commands are expected to be used often. The toolbar takes away space from the content area. If the commands are not important to the view and the main use cases, it is recommendable to not have a toolbar at all, and place the commands in the application menu. Similarly, reconsider your design if you would have only one or two buttons to the toolbar; commands can be placed to the application menu, or embedded to the page.
Note that the toolbar is not scalable: do not place commands in the toolbar if the view is expected to grow with more functionalities in the future.
The commands in the toolbar and in the application menu are not to be duplicated.
Since the Direct UI style has no focus for the items in the content view, it is not possible to create toolbars that have actions that affect on a single item on screen. For instance you shouldn't design a toolbar with "Reply", "Delete", "Move" etc. commands, if the assumption is that these commands would apply only to a single item.
The toolbar affects the scrollable area and the scroll position indicator in portrait mode. The scrollable area ends on top of the toolbar (so that the latest in the list should not end up being stuck behind the toolbar)
The user is not able to personalize the contents of the toolbar. The application designer decides what is shown in the toolbar and what in the application menu.
Application design can also decide whether toolbar is used in both landscape and portrait modes. For example, a toolbar can be shown only in landscape mode, and then in portrait mode the functionalities are provided somewhere else (for instance in the application menu).
The toolbar can be hidden if application designer decides so, for example when using full-screen media, virtual keyboard or web browser. Toolbar is hidden and shown together with command area.
The toolbar remains in a fixed position on screen, on top of contents that are displayed.

Variants

Default toolbar view. View is used to visualize buttons and text input field.
tab view. View is used to visualize mutually exclusive latch-down type of buttons

Open issues

See also:: MToolbarStyle

Definition at line 116 of file corelib/widgets/mtoolbar.h.

Constructor & Destructor Documentation

MToolBar::MToolBar	(	QGraphicsItem *	parent = `0`,
		const QString &	viewType = `""`
	)

Constructs a toolbar containing no actions with optional parent and viewType.

Definition at line 55 of file mtoolbar.cpp.

    : MWidgetController(new MToolBarPrivate(), new MWidgetModel(), parent)
{
    Q_D(MToolBar);
    d->initLayout();
    Q_UNUSED(viewType);
}

MToolBar::~MToolBar ( ) [virtual]

Destructs the toolbar object.

Definition at line 70 of file mtoolbar.cpp.

{
}

MToolBar::MToolBar	(	MToolBarPrivate *	dd,
		MWidgetModel *	model,
		QGraphicsItem *	parent
	)			`[protected]`

protected constructor

Parameters:

	dd	Shared private class
	model	The model. This must not be NULL.
	parent	Parent widget

Definition at line 63 of file mtoolbar.cpp.

    : MWidgetController(dd, model, parent)
{
    Q_D(MToolBar);
    d->initLayout();
}

Member Data Documentation

const MTheme::ViewType MToolBar::tabType = "tab" [static]

Variable that defines id for tab variant of the toolbar.

Definition at line 124 of file corelib/widgets/mtoolbar.h.

MToolBar Class Reference

Public Member Functions

Static Public Attributes