@stable

	\brief The HbView class defines one screen of user interface content.

    The screen area of a mobile device is small, so an application's user interface is often composed of a set of separate screens of content or "views". Each view can contain a number of widgets. A view can also contain a title, an icon (not used at present), a menu and a toolbar. These additional components are called decorators and together they make up the "chrome" of the interface.

    An application will have a number of views to present different kinds of information to the user. You can add multiple views to the \link HbMainWindow main window \endlink of your application and then manage them through the main window object. When a view is activated, the main window handles the updating of the view contents, i.e. the title, icon, menu and toolbar. The view object itself handles the visibility of the toolbar, but the main window will repaint it whenever the view is activated.

    \image html hbview_wireframes.png "Wireframes of two different views in a messaging application"

    \section _usecases_hbview Using the HbView class

    In general, the actual widgets, menu and toolbar that make up the content of a view will be designed with a UI layout tool. This means you do not need to use code to place each widget into the layout but instead load the layout from a file with HbDocumentLoader. Once the view is populated with widgets, you can manipulate them and connect their signals to methods in your application.

    See the HbMainWindow class for information about switching between different views.

    \subsection _uc_001_hbview Hiding and showing the chrome 

    The chrome, (i.e. title, menu and toolbar of the view) can be hidden to allow your application to fill the whole screen. Also, individual components of the chrome can be hidden if desired.

    \code 

    // Hide all the chrome items

    myView.setContentFullScreen(true)

    // Show all the chrome items

    myView.setContentFullScreen(false)

    // Hide the toolbar

    myView.hideItems(Hb::SceneItem::ToolBarItem)

    // Show the toolbar

    myView.showItems(Hb::SceneItem::ToolBarItem)

    \endcode

    \subsection _uc_002_hbview Creating a simple view

    This code snippet shows the most basic way to create an application with a single view.

    \code

    #include <hbapplication.h>

    #include <hbmainwindow.h>

    #include <hbview.h>

    int main(int argc, char *argv[])

    {

        HbApplication app(argc, argv);

        HbMainWindow window;

        HbView *view = new HbView();

        view->setTitle("My View");

        window.addView(view);

        window.show();

        return app.exec();

    }

    \endcode

    \section _methodgroups_hbview Methods and properties grouped

    \li \b Chrome: setViewFlags(), showItems(), hideItems(), visibleItems(), isItemVisible(), setItemVisible(), unsetVisibleItems(),visibleItemsChanged() [signal], setContentFullScreen(), contentFullScreenChanged() [signal], isContentFullScreen(), contentFullScreen [property]

    \li \b Title: title(), setTitle(), titleChanged() [signal], title [property]

    \li \b Icon: icon(), setIcon(), iconChanged() [signal], icon [property]

    \li \b Menu: menu(), setMenu(), takeMenu()

    \li \b Toolbar: toolBar(), setToolBar(), toolBarChanged() [signal], takeToolBar()

    \li \b Actions: addAction(), setNavigationAction()

    \li \b Event: event()

    \li \b TitleBar: setTitleBarVisible()

    \li \b StatusBar: setStatusBarVisible()

    \li \b DockWidget: dockWidget(), setDockWidget(), dockWidgetChanged() [signal]

    \li \b Widget: widget(), setWidget(), takeWidget()

    \sa HbApplication, HbMainWindow, HbDocumentLoader, HbMenu, HbToolBar, HbDockWidget

    When this flag is set, there will be an indication in the titlebar showing the possibility to minimize the titlebar, e.g. swipe it off the screen.

    Show the title bar in minimized state.

    Do not show the title bar at all. The title bar handle is not shown and it is not possible to maximize the title bar.

    Show normal style title bar but make it transparent. This flag is normally used in combination with TitleBarFloating flag.

    Show the title bar floating on top of the underlying content. Setting this flag also make the application area start from the top of the screen. This flag is normally used in combination with TitleBarTransparent flag.

    Do not show the statusbar at all. This flag is normally used in combination with the ViewTitleBarHidden flag.

    Show the statusbar with normal content but transparent. This flag is normally used in combination with ViewStatusBarFloating flag.

    Show the statusbar on top of the underlying content. Setting this flag also changes the application area to start from the top of the screen. This flag is normally used in combination with the ViewStatusBarTransparent flag.

*/

/*!

    \enum HbView::ActionContainer

    Defines the default container when you add actions to a view.

    \sa navigationAction()

*/

/*!

    \var HbView::NotSpecified

    Indicate that no particular action container is preferred.

*/

/*!

    \var HbView::OptionsMenu

    Indicate that the options menu is the preferred location for an action.

*/

/*!

    \var HbView::ToolBar

    Indicate that the tool bar is the preferred location for an action.

    This signal is emitted when the title is replaced by a different title.

    \sa setTitle()

    This signal is emitted when the icon is replaced by a different icon.

    \sa setIcon()

    This signal is emitted when toolbar is replaced by a different toolbar.

    \sa setToolBar()

   \fn void HbView::visibleItemsChanged()

   This signal is emitted when items in the chrome (e.g. toolbar, menu) are made visible or hidden.

   \sa visibleItems()

*/

/*!

   \fn void HbView::contentFullScreenChanged()

   This signal is emitted when the view is set to occupy the whole screen.

   \sa setContentFullScreen()

*/

/*!

   \fn void HbView::dockWidgetChanged()

   This signal is emitted when the dock widget is replaced by a different dock widget.

   \sa setDockWidget()

*/

/*!

/*!

    \internal

 */

/*!

    \internal

 */

    Constructs a view with the given \a parent.

    Destructor.

  Returns the title of the view. If no title has been defined, the return value is a null string.

    Returns the icon associated with the view.

    Sets the icon associated with the view.

    Returns the menu for the view. This function creates and returns an empty menu if one does not already exist.

    Sets the menu for the view. Setting the menu to 0 will remove any existing menu from the view.

    The view takes ownership of the \a menu.

        // Titlebar must be informed

        if (mainWindow()) {

            HbMainWindowPrivate::d_ptr(mainWindow())->mTitleBar->propertiesChanged();

        }

    Returns the toolbar for the view. If the view does not already have a toolbar, an 

	empty toolbar is created and returned to the caller but the toolBarChanged() 

	signal is not emitted.

    Sets the toolbar for the view. Setting the toolbar to 0 will remove it from the view.

    The view takes ownership of the toolbar, but the view is not set as the parent.

Removes the toolbar from the view and returns it to the caller.

Ownership of the toolbar is transferred to the caller.

\note This function is particularly useful if you want to switch to a 

different view and keep the same toolbar.

    Returns the dock widget belonging to the view. If the view does not have a dock widget, an empty dock widget is created and returned.

    The dockWidgetChanged() signal is not emitted when a new dock widget is created by this method.

    Sets the dock widget for the view. Setting the dock widget to \c 0 will remove it from the view.

    This does take ownership of the \a dockWidget, but does not become the parent.

    Returns the widget that makes up the view. If the widget has not been set, this method will return 0.

    \sa setWidget takeWidget

    Sets the widget that makes up the view. Setting the \a widget value to 0 will delete the current widget.

    The view takes the ownership of the \a widget.