Wt  3.3.9
Public Member Functions | Protected Member Functions | List of all members
Wt::WMenu Class Reference

A widget that shows a menu of options. More...

#include <Wt/WMenu>

Inheritance diagram for Wt::WMenu:
Inheritance graph
[legend]

Public Member Functions

 WMenu (Orientation orientation, WContainerWidget *parent=0)
 Creates a new menu (deprecated). More...
 
 WMenu (WContainerWidget *parent=0)
 Creates a new menu. More...
 
 WMenu (WStackedWidget *contentsStack, Orientation orientation, WContainerWidget *parent=0)
 Creates a new menu (deprecated). More...
 
 WMenu (WStackedWidget *contentsStack, WContainerWidget *parent=0)
 Creates a new menu. More...
 
 ~WMenu ()
 Destructor.
 
WMenuItemaddItem (const WString &label, WWidget *contents=0, WMenuItem::LoadPolicy policy=WMenuItem::LazyLoading)
 Adds an item. More...
 
WMenuItemaddItem (const std::string &iconPath, const WString &label, WWidget *contents=0, WMenuItem::LoadPolicy policy=WMenuItem::LazyLoading)
 Adds an item. More...
 
template<class T , class V >
WMenuItemaddItem (const WString &text, T *target, void(V::*method)())
 Adds an item with given text, and specify a slot method to be called when the item is triggered. More...
 
template<class T , class V >
WMenuItemaddItem (const std::string &iconPath, const WString &text, T *target, void(V::*method)())
 Adds an item with given text and icon, and specify a slot method to be called when activated. More...
 
WMenuItemaddMenu (const WString &text, WMenu *menu)
 Adds a submenu, with given text. More...
 
WMenuItemaddMenu (const std::string &iconPath, const WString &text, WMenu *menu)
 Adds a submenu, with given icon and text. More...
 
virtual void addItem (WMenuItem *item)
 Adds an item. More...
 
WMenuIteminsertItem (int index, const WString &label, WWidget *contents=0, WMenuItem::LoadPolicy policy=WMenuItem::LazyLoading)
 inserts an item. More...
 
WMenuIteminsertItem (int index, const std::string &iconPath, const WString &label, WWidget *contents=0, WMenuItem::LoadPolicy policy=WMenuItem::LazyLoading)
 inserts an item. More...
 
template<class T , class V >
WMenuIteminsertItem (int index, const WString &text, T *target, void(V::*method)())
 inserts an item with given text, and specify a slot method to be called when the item is triggered. More...
 
template<class T , class V >
WMenuIteminsertItem (int index, const std::string &iconPath, const WString &text, T *target, void(V::*method)())
 inserts an item with given text and icon, and specify a slot method to be called when activated. More...
 
WMenuIteminsertMenu (int index, const WString &text, WMenu *menu)
 inserts a submenu, with given text. More...
 
WMenuIteminsertMenu (int index, const std::string &iconPath, const WString &text, WMenu *menu)
 inserts a submenu, with given icon and text. More...
 
virtual void insertItem (int index, WMenuItem *item)
 Inserts an item. More...
 
WMenuItemaddSeparator ()
 Adds a separator to the menu. More...
 
WMenuItemaddSectionHeader (const WString &text)
 Adds a section header to the menu.
 
virtual void removeItem (WMenuItem *item)
 Removes an item. More...
 
void select (WMenuItem *item)
 Selects an item. More...
 
void select (int index)
 Selects an item. More...
 
Signal< WMenuItem * > & itemSelected ()
 Signal which indicates that a new item was selected. More...
 
Signal< WMenuItem * > & itemSelectRendered ()
 Signal which indicates that a new selected item is rendered. More...
 
void close (WMenuItem *item)
 Closes an item. More...
 
void close (int index)
 Closes an item. More...
 
std::vector< WMenuItem * > items () const
 Returns the items. More...
 
Signal< WMenuItem * > & itemClosed ()
 Signal which indicates that an item was closed. More...
 
void setItemHidden (WMenuItem *item, bool hidden)
 Hides an item. More...
 
void setItemHidden (int index, bool hidden)
 Hides an item. More...
 
bool isItemHidden (WMenuItem *item) const
 Returns whether the item widget of the given item is hidden. More...
 
bool isItemHidden (int index) const
 Returns whether the item widget of the given index is hidden. More...
 
void setItemDisabled (WMenuItem *item, bool disabled)
 Disables an item. More...
 
void setItemDisabled (int index, bool disabled)
 Disables an item. More...
 
bool isItemDisabled (WMenuItem *item) const
 Returns whether the item widget of the given item is disabled. More...
 
bool isItemDisabled (int index) const
 Returns whether the item widget of the given index is disabled. More...
 
WMenuItemcurrentItem () const
 Returns the currently selected item. More...
 
int currentIndex () const
 Returns the index of the currently selected item. More...
 
Orientation orientation () const
 Returns the orientation (deprecated). More...
 
void setRenderAsList (bool enable)
 Renders using an HTML list (deprecated) More...
 
bool renderAsList () const
 Returns whether the menu is rendered as an HTML list (deprecated). More...
 
void setInternalPathEnabled (const std::string &basePath="")
 Enables internal paths for items. More...
 
bool internalPathEnabled () const
 Returns whether the menu generates internal paths entries. More...
 
void setInternalBasePath (const std::string &basePath)
 Sets the internal base path. More...
 
const std::string & internalBasePath () const
 Returns the internal base path. More...
 
WStackedWidgetcontentsStack () const
 Returns the contents stack associated with the menu.
 
int count () const
 Returns the item count.
 
WMenuItemitemAt (int index) const
 Returns the item by index. More...
 
int indexOf (WMenuItem *item) const
 Returns the index of an item. More...
 
WMenuItemparentItem () const
 Returns the parent item (for a submenu) More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget (WContainerWidget *parent=0)
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (WWidget *implementation, WContainerWidget *parent)
 Creates a WCompositeWidget with given implementation. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setPositionScheme (PositionScheme scheme)
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=All)
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WLength width () const
 Returns the width. More...
 
virtual WLength height () const
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height)
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height)
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height)
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s)
 Specifies a CSS float side. More...
 
virtual Side floatSide () const
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides)
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=All)
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled)
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual bool isPopup () const
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline)
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style)
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle ()
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass)
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false)
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false)
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void setAttributeValue (const std::string &name, const WString &value)
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value)
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args)
 Calls a JavaScript member. More...
 
virtual bool loaded () const
 Returns whether this widget has been loaded. More...
 
virtual void setCanReceiveFocus (bool enabled)
 Sets whether the widget can receive focus. More...
 
virtual bool canReceiveFocus () const
 Returns whether the widget can receive focus. More...
 
virtual void setFocus (bool focus)
 Sets focus. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual bool hasFocus () const
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
virtual void setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &name)
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &js)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
virtual bool scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const WT_CXX11ONLY(finaloverride)
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled)
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
void setWidth (const WLength &width)
 Sets the width. More...
 
void setHeight (const WLength &height)
 Sets the height. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Vertical)
 Positions a widget next to another widget. More...
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping. More...
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping. More...
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation. More...
 
bool isRendered () const
 Returns whether the widget is rendered. More...
 
void hide ()
 Hides the widget. More...
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation. More...
 
void show ()
 Shows the widget. More...
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation. More...
 
void enable ()
 Enables the widget. More...
 
void disable ()
 Disable thes widget. More...
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware. More...
 
- Public Member Functions inherited from Wt::WObject
 WObject (WObject *parent=0)
 Create a WObject with a given parent object. More...
 
virtual ~WObject ()
 Destructor. More...
 
void resetLearnedSlots ()
 Resets learned stateless slot implementations. More...
 
template<class T >
void resetLearnedSlot (void(T::*method)())
 Resets a learned stateless slot implementation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)())
 Declares a slot to be stateless and learn client-side behaviour on first invocation. More...
 
template<class T >
WStatelessSlot * implementStateless (void(T::*method)(), void(T::*undoMethod)())
 Declares a slot to be stateless and learn client-side behaviour in advance. More...
 
void isNotStateless ()
 Marks the current function as not stateless. More...
 
template<class T >
WStatelessSlot * implementJavaScript (void(T::*method)(), const std::string &jsCode)
 Provides a JavaScript implementation for a method. More...
 
void addChild (WObject *child)
 Adds a child object. More...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

Protected Member Functions

virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
virtual void internalPathChanged (const std::string &path)
 Handling of internal path changes. More...
 
virtual int nextAfterHide (int index)
 Returns the index of the item to be selected after hides. More...
 
virtual void select (int index, bool changePath)
 Selects an item. More...
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
void setImplementation (WWidget *widget)
 Set the implementation widget. More...
 
WWidgetimplementation ()
 Get the implementation widget. More...
 
virtual int boxPadding (Orientation orientation) const
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const
 Returns the widget's built-in border width. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
 WWidget (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 

Additional Inherited Members

- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 
- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A widget that shows a menu of options.

The WMenu widget offers menu navigation.

Typically, a menu is used in conjunction with a WStackedWidget (but can be used without too), where different 'contents' are stacked upon each other. Each choice in the menu (which is implemented as a WMenuItem) corresponds to a tab in the contents stack. The contents stack may contain other items, and could be shared with other WMenu instances.

When used without a contents stack, you can react to menu item selection using the itemSelected() signal, to implement some custom handling of item selection.

Usage example:

// create the stack where the contents will be located
Wt::WStackedWidget *contents = new Wt::WStackedWidget(contentsParent);
// create a menu
Wt::WMenu *menu = new Wt::WMenu(contents, menuParent);
// add four items using the default lazy loading policy.
menu->addItem("Introduction", new Wt::WText("intro"));
menu->addItem("Download", new Wt::WText("Not yet available"));
menu->addItem("Demo", new DemoWidget());
menu->addItem(new Wt::WMenuItem("Demo2", new DemoWidget()));

After contruction, the first entry will be selected. At any time, it is possible to select a particular item using select().

Each item of WMenu may be closeable (see WMenuItem::setCloseable(bool). Like selection, at any time, it is possible to close a particular item using close(). You can react to close of item by using the itemClosed() signal.

The WMenu implementation offers fine-grained control on how contents should be preloaded. By default, all contents is lazy-loaded, only when needed. To improve response time, an item may also be preloaded (using addItem()). In that case, the item will be loaded in the background, before its first use. In any case, once the contents corresponding to a menu item is loaded, subsequent navigation to it is handled entirely client-side.

The WMenu may participate in the application's internal path, which lets menu items correspond to internal URLs, see setInternalPathEnabled().

The layout of the menu may be Horizontal or Vertical. The look of the items may be defined through style sheets. The default WMenuItem implementation uses four style classes to distinguish between inactivated, activated, closeable inactivated and closeable activated menu items: "item", "itemselected", "citem", "citemselected". By using CSS nested selectors, a different style may be defined for items in a different menu.

You may customize the rendering and behaviour of menu entries by specializing WMenuItem.

CSS

The menu is rendered as a >ul<. Unless you use the bootstrap theme, you will want to customize the menu using inline or external styles to hide the bullets and provide the appropriate horizontal or vertical layout.

See also
WMenuItem

Constructor & Destructor Documentation

Wt::WMenu::WMenu ( Orientation  orientation,
WContainerWidget parent = 0 
)

Creates a new menu (deprecated).

Construct a menu with given orientation. The menu is not associated with a contents stack, and thus you will want to react to the itemSelected() signal to react to menu changes.

Deprecated:
the orientation parameter is ignored, since menus are now always rendered using <ul> elements, and CSS will determine the orientation. Use WMenu(WContainerWidget *) instead.
Wt::WMenu::WMenu ( WContainerWidget parent = 0)

Creates a new menu.

The menu is not associated with a contents stack, and thus you will want to react to the itemSelected() signal to react to menu changes.

Wt::WMenu::WMenu ( WStackedWidget contentsStack,
Orientation  orientation,
WContainerWidget parent = 0 
)

Creates a new menu (deprecated).

Construct a menu to manage the widgets in contentsStack, and sets the menu orientation.

Each menu item will manage a single widget in the contentsStack, making it the current widget when the menu item is activated.

Deprecated:
the orientation parameter is ignored, since menus are now always rendered using <ul> elements, and CSS will determine the orientation. Use WMenu(WStackedWidget *contentsStack, WContainerWidget *) instead.
Wt::WMenu::WMenu ( WStackedWidget contentsStack,
WContainerWidget parent = 0 
)

Creates a new menu.

Construct a menu to manage the widgets in contentsStack.

Each menu item will manage a single widget in the contentsStack, making it the current widget when the menu item is activated.

Member Function Documentation

WMenuItem * Wt::WMenu::addItem ( const WString label,
WWidget contents = 0,
WMenuItem::LoadPolicy  policy = WMenuItem::LazyLoading 
)

Adds an item.

Use this version of addItem() if you do not want to specify an icon for this menu item.

Returns the corresponding WMenuItem.

See also
addItem(const std::string&, const WString&, WWidget *, WMenuItem::LoadPolicy)
addItem(WMenuItem *)
WMenuItem * Wt::WMenu::addItem ( const std::string &  iconPath,
const WString label,
WWidget contents = 0,
WMenuItem::LoadPolicy  policy = WMenuItem::LazyLoading 
)

Adds an item.

Adds a menu item with given contents, which is added to the menu's associated contents stack.

contents may be 0 for two reasons:

  • if the menu is not associated with a contents stack, then you cannot associate a menu item with a contents widget
  • or, you may have one or more items which which are not associated with a contents widget in the contents stack.

Returns the corresponding WMenuItem.

See also
addItem(WMenuItem *)
template<class T , class V >
WMenuItem * Wt::WMenu::addItem ( const WString text,
T *  target,
void(V::*)()  method 
)

Adds an item with given text, and specify a slot method to be called when the item is triggered.

The target and method are connected to the WMenuItem::triggered signal.

See also
add(WMenuItem *)
template<class T , class V >
WMenuItem * Wt::WMenu::addItem ( const std::string &  iconPath,
const WString text,
T *  target,
void(V::*)()  method 
)

Adds an item with given text and icon, and specify a slot method to be called when activated.

The target and method are connected to the WMenuItem::triggered signal.

Note
The icon should have a width of 16 pixels.
See also
add(WMenuItem *)
void Wt::WMenu::addItem ( WMenuItem item)
virtual

Adds an item.

Adds a menu item. Use this form to add specialized WMenuItem implementations.

See also
addItem(const WString&, WWidget *, WMenuItem::LoadPolicy)
WMenuItem * Wt::WMenu::addMenu ( const WString text,
WMenu menu 
)

Adds a submenu, with given text.

Adds an item with text text, that leads to a submenu menu.

See also
add(WMenuItem *)
WMenuItem * Wt::WMenu::addMenu ( const std::string &  iconPath,
const WString text,
WMenu menu 
)

Adds a submenu, with given icon and text.

Adds an item with given text and icon, that leads to a submenu menu.

See also
add(WMenuItem *)
WMenuItem * Wt::WMenu::addSeparator ( )

Adds a separator to the menu.

Adds a separator the menu.

void Wt::WMenu::close ( WMenuItem item)

Closes an item.

Close the menu item item. Only closeable items can be closed.

See also
close(int), WMenuItem::close()
void Wt::WMenu::close ( int  index)

Closes an item.

Menu items in a menu with N items are numbered from 0 to N - 1.

See also
close(WMenuItem *)
int Wt::WMenu::currentIndex ( ) const

Returns the index of the currently selected item.

See also
currentItem(), select(int)
WMenuItem * Wt::WMenu::currentItem ( ) const

Returns the currently selected item.

See also
currentIndex(), select(WMenuItem *)
int Wt::WMenu::indexOf ( WMenuItem item) const

Returns the index of an item.

See also
itemAt()
WMenuItem * Wt::WMenu::insertItem ( int  index,
const WString label,
WWidget contents = 0,
WMenuItem::LoadPolicy  policy = WMenuItem::LazyLoading 
)

inserts an item.

Use this version of insertItem() if you do not want to specify an icon for this menu item.

Returns the corresponding WMenuItem.

See also
insertItem(int index, const std::string&, const WString&, WWidget *, WMenuItem::LoadPolicy)
insertItem(int index, WMenuItem *)
WMenuItem * Wt::WMenu::insertItem ( int  index,
const std::string &  iconPath,
const WString label,
WWidget contents = 0,
WMenuItem::LoadPolicy  policy = WMenuItem::LazyLoading 
)

inserts an item.

inserts a menu item with given contents, which is inserted to the menu's associated contents stack.

contents may be 0 for two reasons:

  • if the menu is not associated with a contents stack, then you cannot associate a menu item with a contents widget
  • or, you may have one or more items which which are not associated with a contents widget in the contents stack.

Returns the corresponding WMenuItem.

See also
insertItem(int index, WMenuItem *)
template<class T , class V >
WMenuItem * Wt::WMenu::insertItem ( int  index,
const WString text,
T *  target,
void(V::*)()  method 
)

inserts an item with given text, and specify a slot method to be called when the item is triggered.

The target and method are connected to the WMenuItem::triggered signal.

See also
insert(int index,WMenuItem *)
template<class T , class V >
WMenuItem * Wt::WMenu::insertItem ( int  index,
const std::string &  iconPath,
const WString text,
T *  target,
void(V::*)()  method 
)

inserts an item with given text and icon, and specify a slot method to be called when activated.

The target and method are connected to the WMenuItem::triggered signal.

Note
The icon should have a width of 16 pixels.
See also
insert(int index, WMenuItem *)
void Wt::WMenu::insertItem ( int  index,
WMenuItem item 
)
virtual

Inserts an item.

Inserts a menu item. Use this form to insert specialized WMenuItem implementations.

See also
insertItem(WMenuItem *item)
WMenuItem * Wt::WMenu::insertMenu ( int  index,
const WString text,
WMenu menu 
)

inserts a submenu, with given text.

inserts an item with text text, that leads to a submenu menu.

See also
insert(int index, WMenuItem *)
WMenuItem * Wt::WMenu::insertMenu ( int  index,
const std::string &  iconPath,
const WString text,
WMenu menu 
)

inserts a submenu, with given icon and text.

inserts an item with given text and icon, that leads to a submenu menu.

See also
insert(int index, WMenuItem *)
const std::string& Wt::WMenu::internalBasePath ( ) const

Returns the internal base path.

The default value is the application's internalPath (WApplication::internalPath()) that was recorded when setInternalPathEnabled() was called, and together with each WMenuItem::pathComponent() determines the paths for each item.

For example, if internalBasePath() is "/examples/" and pathComponent() for a particular item is "charts/", then the internal path for that item will be "/examples/charts/".

See also
setInternalPathEnabled()
void Wt::WMenu::internalPathChanged ( const std::string &  path)
protectedvirtual

Handling of internal path changes.

This methods makes the menu react to internal path changes (and also the initial internal path).

You may want to reimplement this if you want to customize the internal path handling.

bool Wt::WMenu::internalPathEnabled ( ) const

Returns whether the menu generates internal paths entries.

See also
setInternalPathEnabled()
bool Wt::WMenu::isItemDisabled ( WMenuItem item) const

Returns whether the item widget of the given item is disabled.

See also
setItemDisabled()
bool Wt::WMenu::isItemDisabled ( int  index) const

Returns whether the item widget of the given index is disabled.

Menu items in a menu with N items are numbered from 0 to N - 1.

See also
setItemDisabled()
bool Wt::WMenu::isItemHidden ( WMenuItem item) const

Returns whether the item widget of the given item is hidden.

See also
setItemHidden()
bool Wt::WMenu::isItemHidden ( int  index) const

Returns whether the item widget of the given index is hidden.

Menu items in a menu with N items are numbered from 0 to N - 1.

See also
setItemHidden()
WMenuItem * Wt::WMenu::itemAt ( int  index) const

Returns the item by index.

See also
indexOf()
Signal<WMenuItem *>& Wt::WMenu::itemClosed ( )

Signal which indicates that an item was closed.

This signal is emitted when an item was closed. It is emitted both when the user closes an item, or when close() was invoked.

std::vector< WMenuItem * > Wt::WMenu::items ( ) const

Returns the items.

Returns the list of menu items in this menu.

See also
itemAt()
Signal<WMenuItem *>& Wt::WMenu::itemSelected ( )

Signal which indicates that a new item was selected.

This signal is emitted when an item was selected. It is emitted both when the user activated an item, or when select() was invoked.

See also
itemSelectRendered()
Signal<WMenuItem *>& Wt::WMenu::itemSelectRendered ( )

Signal which indicates that a new selected item is rendered.

This signal is similar to itemSelected, but is emitted from within a stateless slot. Therefore, any slot connected to this signal will be optimized to client-side JavaScript, and must support the contract of a stateless slot (i.e., be idempotent).

If you are unsure what is the difference with the itemSelected signal, you'll probably need the latter instead.

See also
itemSelected()
void Wt::WMenu::load ( )
virtual

Loads content just before the widget is used.

This method is called after a widget is inserted in the widget hierarchy and fully constructed, but before the widget is rendered. Widgets that get inserted in the widget hierarchy will be rendered. Visible widgets are rendered immediately, and invisible widgets in the back-ground (or not for a plain HTML session). This method is called when the widget is directly or indirectly inserted into the widget tree.

The default implementation simply propagates the load signal to its children. You may want to override this method to delay loading of resource-intensive contents.

During the life-time of a widget, this method may be called multiple times, so you should make sure that you do a deferred initializiation only once.

Reimplemented from Wt::WCompositeWidget.

int Wt::WMenu::nextAfterHide ( int  index)
protectedvirtual

Returns the index of the item to be selected after hides.

Returns the index of the item to be selected after the item with given index will be hidden.

By default, if the given index is an index of currently selected item, returns an index of the first visible item to the right of it. If it is not found, returns the index of the first visible item to the left of it. If there are no visible items around the currently selected item, returns the index of currently selected item.

You may want to reimplement this if you want to customize the algorithm of determining the index of the item to be selected after hiding the item with given index.

Orientation Wt::WMenu::orientation ( ) const

Returns the orientation (deprecated).

The orientation is set at time of construction.

Deprecated:
this function no longer has any use and will be removed.
WMenuItem* Wt::WMenu::parentItem ( ) const

Returns the parent item (for a submenu)

This is the item with which this menu is associated as a submenu (if any).

void Wt::WMenu::removeItem ( WMenuItem item)
virtual

Removes an item.

Removes the given item. The item and its contents is not deleted.

See also
addItem()
void Wt::WMenu::render ( WFlags< RenderFlag flags)
protectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WCompositeWidget.

Reimplemented in Wt::WPopupMenu.

bool Wt::WMenu::renderAsList ( ) const

Returns whether the menu is rendered as an HTML list (deprecated).

Deprecated:
this function no longer has any use and will be removed.
void Wt::WMenu::select ( WMenuItem item)

Selects an item.

Select the menu item item.

When item is 0, the current selection is removed.

See also
select(int), currentItem(), WMenuItem::select()
void Wt::WMenu::select ( int  index)

Selects an item.

Menu items in a menu with N items are numbered from 0 to N - 1.

Using a value of -1 removes the current selection.

See also
select(WMenuItem *), currentIndex()
void Wt::WMenu::select ( int  index,
bool  changePath 
)
protectedvirtual

Selects an item.

This is the internal function that implements the selection logic, including optional internal path change (if changePath is true). The latter may be false in case an internal path change itself is the reason for selection.

void Wt::WMenu::setInternalBasePath ( const std::string &  basePath)

Sets the internal base path.

A '/' is appended to turn it into a folder, if needed.

See also
setInternalPathEnabled(), internalBasePath()
void Wt::WMenu::setInternalPathEnabled ( const std::string &  basePath = "")

Enables internal paths for items.

The menu participates in the internal path by changing the internal path when an item has been selected, and listening for path changes to react to path selections. As a consequence this allows the user to bookmark the current menu selection and revisit it later, use back/forward buttons to navigate through history of visited menu items, and allows indexing of pages.

For each menu item, WMenuItem::pathComponent() is appended to the basePath, which defaults to the internal path (WApplication::internalPath()). A '/' is appended to the base path, to turn it into a folder, if needed.

By default, menu interaction does not change the application internal path.

See also
WMenuItem::setPathComponent().
void Wt::WMenu::setItemDisabled ( WMenuItem item,
bool  disabled 
)

Disables an item.

Disables the menu item item. Only an item that is enabled can be selected. By default, all menu items are enabled.

See also
setItemDisabled(int, bool), WMenuItem::setDisabled()
void Wt::WMenu::setItemDisabled ( int  index,
bool  disabled 
)

Disables an item.

Menu items in a menu with N items are numbered from 0 to N - 1.

See also
setItemDisabled(WMenuItem *, bool)
void Wt::WMenu::setItemHidden ( WMenuItem item,
bool  hidden 
)

Hides an item.

Hides the menu item item. By default, all menu items are visible.

If the item was currently selected, then the next item to be selected is determined by nextAfterHide().

See also
setItemHidden(int, bool), WMenuItem::hide()
void Wt::WMenu::setItemHidden ( int  index,
bool  hidden 
)

Hides an item.

Menu items in a menu with N items are numbered from 0 to N - 1.

See also
setItemHidden(WMenuItem *, bool)
void Wt::WMenu::setRenderAsList ( bool  enable)

Renders using an HTML list (deprecated)

This function no longer has an effect, as a menu is now always rendered as a list.

Deprecated:
this function no longer has any use and will be removed.

Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11