NovaTK::Menubar Class Reference

Inheritance diagram for NovaTK::Menubar:
Collaboration diagram for NovaTK::Menubar:

List of all members.


Detailed Description

A menubar provides a series of triggers for application menus. Menus provided by a menubar are created and destroyed by the menubar(This does not include submenus).

Public Member Functions

virtual NOVATKAPI NStatus Create (Window *parent, int c_x, int c_y, int c_width, int c_height)
virtual NOVATKAPI NStatus DeleteMenu (Menu *d_menu)
virtual NOVATKAPI void Destroy ()
virtual NOVATKAPI MenuInsertMenu (const NString &name)

Member Function Documentation

NStatus NovaTK::Menubar::Create ( Window parent,
int  c_x,
int  c_y,
int  c_width,
int  c_height 
) [virtual]

This function is used by all widgets for initialization and to specify essential parameters. Each widget will reimplement this function but a few will have different parameters as needed(Such as Label). Most other member functions of all widgets cannot be called before calling this one except generally functions that specify attributes that must be known before creation of the widget.

Parameters:
parent Specifies the parent window.
c_x Specifies the location of the window's top-left corner along the X-axis relative to its parent.
c_y Specifies the location of the window's top-left corner along the Y-axis relative to its parent.
c_width Specifies the width of the window.
c_height Specifies the height of the window.
Returns:
NOVATK_SUCCESS upon successful creation of the widget otherwise returns NOVATK_ERROR_GENERAL_FAILURE.
Note:
By default, the widget has no border. When a widget is given a border, the top-left corner of the border itself will be the window's X and Y position minus its border width. The actual width of the widget with its border will be its width plus the border width and the same for height.

Reimplemented from NovaTK::Widget.

NStatus NovaTK::Menubar::DeleteMenu ( Menu d_menu  )  [virtual]

Destroys the specified menu and removes its trigger.

Returns:
NOVATK_ERROR_DOES_NOT_EXIST if the specified menu was not created by this widget, otherwise returns NOVATK_SUCCESS.

void NovaTK::Menubar::Destroy (  )  [virtual]

Destroys the widget.

Reimplemented from NovaTK::Widget.

Menu * NovaTK::Menubar::InsertMenu ( const NString name  )  [virtual]

Creates a menu and an associate trigger with the specified name after the last trigger created.

Returns:
A pointer to the menu created. Do not attempt to destroy or delete this widget as it is owned by the menubar that created it!


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

Generated on Sat Sep 13 22:34:21 2008 for NovaTK by  doxygen 1.5.5