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

A single item in a menu. More...

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

Public Types

- Public Types inherited from Wt::WContainerWidget
- Public Types inherited from Wt::WObject
typedef void(WObject::* Method) ()
 Typedef for a WObject method without arguments.
 

Public Member Functions

 WMenuItem (const WString &label, WWidget *contents=0, LoadPolicy policy=LazyLoading)
 Creates a new item with given label. More...
 
void setText (const WString &text)
 Sets the text for this item. More...
 
const WStringtext () const
 Returns the text for this item. More...
 
void setIcon (const std::string &path)
 Sets the item icon path. More...
 
std::string icon () const
 Returns the item icon path. More...
 
void setCheckable (bool checkable)
 Sets if the item is checkable. More...
 
bool isCheckable () const
 Returns whether the item is checkable. More...
 
virtual void setPathComponent (const std::string &path)
 Sets the path component for this item. More...
 
virtual std::string pathComponent () const
 Returns the path component for this item. More...
 
virtual void setInternalPathEnabled (bool enabled)
 Configures internal path support for the item. More...
 
virtual bool internalPathEnabled () const
 Returns whether an item participates in internal paths. More...
 
void setLink (const WLink &link)
 Sets the associated link. More...
 
WLink link () const
 Returns the associated link. More...
 
void setLinkTarget (AnchorTarget target)
 Sets the link target. More...
 
AnchorTarget linkTarget () const
 Returns the link target. More...
 
void setMenu (WMenu *menu)
 Sets a sub menu. More...
 
void setSubMenu (WMenu *menu)
 Sets a sub menu (deprecated) More...
 
WMenumenu () const
 Returns the submenu. More...
 
void setChecked (bool checked)
 Sets the checked state. More...
 
bool isChecked () const
 Returns the checked state. More...
 
void setSelectable (bool selectable)
 Sets whether the menu item can be selected. More...
 
bool isSelectable () const
 Returns whether the menu item can be selected. More...
 
void setData (void *data)
 Sets associated additional data with the item. More...
 
void * data () const
 Returns additional data of the item. More...
 
WCheckBoxcheckBox () const
 Returns the checkbox for a checkable item. More...
 
void setCloseable (bool closeable)
 Make it possible to close this item interactively or by close(). More...
 
bool isCloseable () const
 Returns whether the item is closeable. More...
 
void close ()
 Closes this item. More...
 
WMenuparentMenu () const
 Returns the menu that contains this item.
 
void setContents (WWidget *contents, LoadPolicy policy=LazyLoading)
 Sets the contents widget for this item. More...
 
WWidgetcontents () const
 Returns the contents widget for this item. More...
 
WWidgetitemWidget ()
 Returns the widget that represents the item (deprecated). More...
 
void select ()
 Selects this item. More...
 
Signal< WMenuItem * > & triggered ()
 Signal emitted when an item is activated. More...
 
bool isSeparator () const
 Returns whether this item is a separator. More...
 
bool isSectionHeader () const
 Returns whether this item is a section header. More...
 
WAnchoranchor () const
 Returns the anchor of this menu item. More...
 
virtual void renderSelected (bool selected)
 Renders the item as selected or unselected. More...
 
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
- Public Member Functions inherited from Wt::WContainerWidget
 WContainerWidget (WContainerWidget *parent=0)
 Creates a container with optional parent.
 
 ~WContainerWidget ()
 Destructor.
 
void setLayout (WLayout *layout)
 Sets a layout manager for the container. More...
 
void setLayout (WLayout *layout, WFlags< AlignmentFlag > alignment)
 Sets a layout manager for the container (deprecated). More...
 
WLayoutlayout ()
 Returns the layout manager that was set for the container. More...
 
virtual void addWidget (WWidget *widget)
 Adds a child widget to this container. More...
 
virtual void insertBefore (WWidget *widget, WWidget *before)
 Inserts a child widget in this container, before another widget. More...
 
virtual void insertWidget (int index, WWidget *widget)
 Inserts a child widget in this container at given index. More...
 
virtual void removeWidget (WWidget *widget)
 Removes a child widget from this container. More...
 
virtual void clear ()
 Removes and deletes all child widgets. More...
 
virtual int indexOf (WWidget *widget) const
 Returns the index of a widget.
 
virtual WWidgetwidget (int index) const
 Returns the widget at index
 
virtual int count () const
 Returns the number of widgets in this container.
 
void setContentAlignment (WFlags< AlignmentFlag > contentAlignment)
 Specifies how child widgets must be aligned within the container. More...
 
void setPadding (const WLength &padding, WFlags< Side > sides=All)
 Sets padding inside the widget. More...
 
WLength padding (Side side) const
 Returns the padding set for the widget. More...
 
WFlags< AlignmentFlagcontentAlignment () const
 Returns the alignment of children. More...
 
void setOverflow (Overflow overflow, WFlags< Orientation > orientation=(Horizontal|Vertical))
 Sets how overflow of contained children must be handled. More...
 
void setList (bool list, bool ordered=false)
 Renders the container as an HTML list. More...
 
bool isList () const
 Returns if this container is rendered as a List. More...
 
bool isUnorderedList () const
 Returns if this container is rendered as an Unordered List. More...
 
bool isOrderedList () const
 Returns if this container is rendered as an Ordered List. More...
 
EventSignal< WScrollEvent > & scrolled ()
 Event signal emitted when scrolling in the widget. More...
 
int scrollTop () const
 return the number of pixels the container is scrolled horizontally More...
 
int scrollLeft () const
 return the number of pixels the container is scrolled vertically More...
 
- Public Member Functions inherited from Wt::WInteractWidget
 WInteractWidget (WContainerWidget *parent=0)
 Create an InteractWidget with optional parent.
 
EventSignal< WKeyEvent > & keyWentDown ()
 Event signal emitted when a keyboard key is pushed down. More...
 
EventSignal< WKeyEvent > & keyPressed ()
 Event signal emitted when a "character" was entered. More...
 
EventSignal< WKeyEvent > & keyWentUp ()
 Event signal emitted when a keyboard key is released. More...
 
EventSignalenterPressed ()
 Event signal emitted when enter was pressed. More...
 
EventSignalescapePressed ()
 Event signal emitted when escape was pressed. More...
 
EventSignal< WMouseEvent > & clicked ()
 Event signal emitted when a mouse key was clicked on this widget. More...
 
EventSignal< WMouseEvent > & doubleClicked ()
 Event signal emitted when a mouse key was double clicked on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentDown ()
 Event signal emitted when a mouse key was pushed down on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentUp ()
 Event signal emitted when a mouse key was released on this widget. More...
 
EventSignal< WMouseEvent > & mouseWentOut ()
 Event signal emitted when the mouse went out of this widget. More...
 
EventSignal< WMouseEvent > & mouseWentOver ()
 Event signal emitted when the mouse entered this widget. More...
 
EventSignal< WMouseEvent > & mouseMoved ()
 Event signal emitted when the mouse moved over this widget. More...
 
EventSignal< WMouseEvent > & mouseDragged ()
 Event signal emitted when the mouse is dragged over this widget. More...
 
EventSignal< WMouseEvent > & mouseWheel ()
 Event signal emitted when the mouse scroll wheel was used. More...
 
EventSignal< WTouchEvent > & touchStarted ()
 Event signal emitted when a finger is placed on the screen. More...
 
EventSignal< WTouchEvent > & touchEnded ()
 Event signal emitted when a finger is removed from the screen. More...
 
EventSignal< WTouchEvent > & touchMoved ()
 Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More...
 
EventSignal< WGestureEvent > & gestureStarted ()
 Event signal emitted when a gesture is started. More...
 
EventSignal< WGestureEvent > & gestureChanged ()
 Event signal emitted when a gesture is changed. More...
 
EventSignal< WGestureEvent > & gestureEnded ()
 Event signal emitted when a gesture is ended. More...
 
void setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0)
 Configure dragging for drag and drop. More...
 
void unsetDraggable ()
 Disable drag & drop for this widget. More...
 
void setMouseOverDelay (int delay)
 Sets a delay for the mouse over event. More...
 
int mouseOverDelay () const
 Returns the mouse over signal delay. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
- Public Member Functions inherited from Wt::WWebWidget
 WWebWidget (WContainerWidget *parent=0)
 Construct a WebWidget with a given parent. 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 bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. 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())
 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 void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
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 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 &id)
 Finds a descendent widget by id.
 
virtual void doJavaScript (const std::string &javascript)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
void setLoadLaterWhenInvisible (bool)
 Change the way the widget is loaded when invisible. More...
 
std::string htmlTagName () const
 returns the current html tag name More...
 
void setHtmlTagName (const std::string &tag)
 set the custom HTML tag name More...
 
const std::vector< WWidget * > & children () const
 Returns contained widgets. More...
 
SignalchildrenChanged ()
 Signal emitted when children have been added or removed. 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 bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual void setFocus (bool focus)
 Sets focus. 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...
 
EventSignalblurred ()
 Signal emitted when the widget lost focus. More...
 
EventSignalfocussed ()
 Signal emitted when the widget recieved focus. 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 setObjectName (const std::string &name)
 Sets an object name. 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...
 
virtual std::string objectName () const
 Returns the object name. 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...
 
- Protected Member Functions inherited from Wt::WInteractWidget
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
- Protected Member Functions inherited from Wt::WWebWidget
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. 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...
 
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...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Wt::WWebWidget
static WString escapeText (const WString &text, bool newlinesToo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static std::string & escapeText (std::string &text, bool newlinestoo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static bool removeScript (WString &text)
 Remove tags/attributes from text that are not passive (deprecated). More...
 
static std::string jsStringLiteral (const std::string &v, char delimiter= '\'')
 Turn a UTF8 encoded string into a JavaScript string literal. More...
 
- 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 single item in a menu.

Since Wt 3.3.0, this item is now a proper widget, which renders a single item in a menu.

An optional contents item can be associated with a menu item, which is inserted and shown in the widget stack of the menu to which this menu item belongs.

CSS

A menu item renders as a >li&;lt with additional markup/style classes provided by the theme. Unless you use the bootstrap theme, you will need to provide appropriate CSS.

Member Enumeration Documentation

Enumeration that determines when contents should be loaded.

Enumerator
LazyLoading 

Lazy loading: on first use.

PreLoading 

Pre-loading: before first use.

Constructor & Destructor Documentation

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

Creates a new item with given label.

The optional contents is a widget that will be shown in the WMenu contents stack when the item is selected. For this widget, a load policy specifies whether the contents widgets is transmitted only when it the item is activated for the first time (LazyLoading) or transmitted prior to first rendering.

If the menu supports internal path navigation, then a default pathComponent() will be derived from the label, and can be customized using setPathComponent().

Member Function Documentation

WAnchor * Wt::WMenuItem::anchor ( ) const

Returns the anchor of this menu item.

Can be used to add widgets to the menu.

WCheckBox* Wt::WMenuItem::checkBox ( ) const

Returns the checkbox for a checkable item.

See also
setCheckable()
void Wt::WMenuItem::close ( )

Closes this item.

Hides the item widget and emits WMenu::itemClosed() signal. Only closeable items can be closed.

See also
setCloseable(), hide()
WWidget * Wt::WMenuItem::contents ( ) const

Returns the contents widget for this item.

See also
setContents()
void* Wt::WMenuItem::data ( ) const

Returns additional data of the item.

See also
setData()
void Wt::WMenuItem::enableAjax ( )
virtual

Progresses to an Ajax-enabled widget.

This method is called when the progressive bootstrap method is used, and support for AJAX has been detected. The default behavior will upgrade the widget's event handling to use AJAX instead of full page reloads, and propagate the call to its children.

You may want to reimplement this method if you want to make changes to widget when AJAX is enabled. You should always call the base implementation.

See also
WApplication::enableAjax()

Reimplemented from Wt::WWebWidget.

std::string Wt::WMenuItem::icon ( ) const

Returns the item icon path.

See also
setIcon()
bool Wt::WMenuItem::internalPathEnabled ( ) const
virtual

Returns whether an item participates in internal paths.

See also
setInternalPathEnabled()
bool Wt::WMenuItem::isCheckable ( ) const

Returns whether the item is checkable.

See also
setCheckable()
bool Wt::WMenuItem::isChecked ( ) const

Returns the checked state.

This is only used when isCheckable() == true.

See also
setChecked(bool), isCheckable()
bool Wt::WMenuItem::isCloseable ( ) const

Returns whether the item is closeable.

See also
setCloseable()
bool Wt::WMenuItem::isSectionHeader ( ) const

Returns whether this item is a section header.

See also
WMenu::addSectionHeader()
bool Wt::WMenuItem::isSelectable ( ) const

Returns whether the menu item can be selected.

See also
setSelectable()
bool Wt::WMenuItem::isSeparator ( ) const

Returns whether this item is a separator.

See also
WMenu::addSeparator()
WWidget * Wt::WMenuItem::itemWidget ( )

Returns the widget that represents the item (deprecated).

This returns this.

Deprecated:
This is a pre-Wt 3.3.0 artifact which has lost its value since WMenuItem is now a widget.
WLink Wt::WMenuItem::link ( ) const

Returns the associated link.

See also
setLink()
AnchorTarget Wt::WMenuItem::linkTarget ( ) const

Returns the link target.

See also
setLinkTarget()
WMenu* Wt::WMenuItem::menu ( ) const

Returns the submenu.

See also
setMenu()
std::string Wt::WMenuItem::pathComponent ( ) const
virtual

Returns the path component for this item.

You may want to reimplement this to customize the path component set by the item in the application internal path.

See also
setPathComponent()
Note
the path component is UTF8 encoded (we may fix the API to use WString in the future).
void Wt::WMenuItem::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::WWebWidget.

void Wt::WMenuItem::renderSelected ( bool  selected)
virtual

Renders the item as selected or unselected.

The default implementation sets the styleclass for itemWidget() to 'item' for an unselected not closeable, 'itemselected' for selected not closeable, 'citem' for an unselected closeable and 'citemselected' for selected closeable item.

Note that this method is called from within a stateless slot implementation, and thus should be stateless as well.

void Wt::WMenuItem::select ( )

Selects this item.

If the item was previously closed it will be shown.

See also
close()
void Wt::WMenuItem::setCheckable ( bool  checkable)

Sets if the item is checkable.

When an item is checkable, a checkbox is displayed to the left of the item text (instead of an icon).

See also
setChecked(), isChecked()
void Wt::WMenuItem::setChecked ( bool  checked)

Sets the checked state.

This is only used when isCheckable() == true.

See also
setCheckable(bool), isCheckable()
void Wt::WMenuItem::setCloseable ( bool  closeable)

Make it possible to close this item interactively or by close().

See also
close(), isCloseable()
void Wt::WMenuItem::setContents ( WWidget contents,
LoadPolicy  policy = LazyLoading 
)

Sets the contents widget for this item.

The contents is a widget that will be shown in the WMenu contents stack when the item is selected. For this widget, the load policy specifies whether the contents widgets is transmitted only when it the item is activated for the first time (LazyLoading) or transmitted prior to first rendering.

void Wt::WMenuItem::setData ( void *  data)

Sets associated additional data with the item.

You can use this to associate model information with a menu item.

void Wt::WMenuItem::setDisabled ( bool  disabled)
virtual

Sets whether the widget is disabled.

Enables or disables the widget (including all its descendant widgets). setDisabled(false) will enable this widget and all descendant widgets that are not disabled. A widget is only enabled if it and all its ancestors in the widget tree are disabled.

Typically, a disabled form widget will not allow changing the value, and disabled widgets will not react to mouse click events.

Note
enable() and disable() are considered to be stateless slots by default. If you override setDisabled() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().
See also
disable(), enable()

Reimplemented from Wt::WWebWidget.

void Wt::WMenuItem::setHidden ( bool  hidden,
const WAnimation animation = WAnimation() 
)
virtual

Hides or shows the widget.

Hides or show the widget (including all its descendant widgets). When setting hidden = false, this widget and all descendant widgets that are not hidden will be shown. A widget is only visible if it and all its ancestors in the widget tree are visible, which may be checked using isVisible().

Note
hide() and show() are considered to be stateless slots by default. If you override setHidden() and need to modify server state whenever it is called, you'll need to call WObject::isNotStateless().

Reimplemented from Wt::WWebWidget.

void Wt::WMenuItem::setIcon ( const std::string &  path)

Sets the item icon path.

The icon should have a width of 16 pixels.

See also
setText()
void Wt::WMenuItem::setInternalPathEnabled ( bool  enabled)
virtual

Configures internal path support for the item.

This configures whether the item supports internal paths (in a menu which supports internal paths).

The default value is true for all items but section headers and separators.

See also
WMenu::setInternalPathEnabled()
void Wt::WMenuItem::setLink ( const WLink link)

Sets the associated link.

See also
Link()
void Wt::WMenuItem::setLinkTarget ( AnchorTarget  target)

Sets the link target.

See also
setLink()
void Wt::WMenuItem::setMenu ( WMenu menu)

Sets a sub menu.

Ownership of the subMenu is transferred to the item. In most cases, the sub menu would use the same contents stack as the parent menu.

Note that adding a submenu makes this item not selectable by default.

Note
If the parent menu is a WPopupMenu, the submenu should also be a WPopupMenu.
See also
setSelectable()
void Wt::WMenuItem::setPathComponent ( const std::string &  path)
virtual

Sets the path component for this item.

The path component is used by the menu item in the application internal path (see WApplication::setInternalPath()), when internal paths are enabled (see WMenu::setInternalPathEnabled()) for the menu.

You may specify an empty path to let a menu item be the "default" menu option.

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

By default, the path is automatically derived from text(). If a literal text is used, the path is based on the text itself, otherwise on the key. It is converted to lower case, and replacing white space and special characters with '_'.

See also
setText(), WMenu::setInternalPathEnabled()
Note
the path should be UTF8 encoded (we may fix the API to use WString in the future).
void Wt::WMenuItem::setSelectable ( bool  selectable)
virtual

Sets whether the menu item can be selected.

Only a menu item that can be selected can be the result of a popup menu selection.

The default value is true for a normal menu item, and false for a menu item that has a submenu.

An item that is selectable but is disabled can still not be selected.

Reimplemented from Wt::WWebWidget.

void Wt::WMenuItem::setSubMenu ( WMenu menu)

Sets a sub menu (deprecated)

Deprecated:
use setMenu() instead
void Wt::WMenuItem::setText ( const WString text)

Sets the text for this item.

Unless a custom path component was defined, the pathComponent() is also updated based on the new text.

The item widget is updated using updateItemWidget().

See also
setPathComponent();
const WString & Wt::WMenuItem::text ( ) const

Returns the text for this item.

See also
setText();
Signal<WMenuItem *>& Wt::WMenuItem::triggered ( )

Signal emitted when an item is activated.

Returns this item as argument.

See also
WMenu::triggered()

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