tcMenu
Public Member Functions | List of all members
MenuManagerObserver Class Referenceabstract

#include <tcMenu.h>

Inheritance diagram for MenuManagerObserver:
CommitCallbackObserver RenderingMenuMgrObserver

Public Member Functions

virtual void structureHasChanged ()=0
 
virtual bool menuEditStarting (MenuItem *item)=0
 
virtual void menuEditEnded (MenuItem *item)=0
 
virtual void activeItemHasChanged (MenuItem *)
 

Detailed Description

Used with the change notification method on MenuManager to be notified when there is an important event on the menu.. Implement this class in order to receive edit and structure change notifications.

Member Function Documentation

◆ structureHasChanged()

virtual void MenuManagerObserver::structureHasChanged ( )
pure virtual

Indicates that the menu structure has changed in a way that requires a new bootstrap and complete redraw. For example when a new menu item is added, or when static values such as the name or info block data change.

Implemented in CommitCallbackObserver, and RenderingMenuMgrObserver.

◆ menuEditStarting()

virtual bool MenuManagerObserver::menuEditStarting ( MenuItem item)
pure virtual

This method is called when editing is started with the menu manager, you can prevent editing by returning false.

Parameters
itemthe item that is about to start editing
Returns
true to allow editing, otherwise false

Implemented in RenderingMenuMgrObserver, and CommitCallbackObserver.

◆ menuEditEnded()

virtual void MenuManagerObserver::menuEditEnded ( MenuItem item)
pure virtual

This method indicates that editing has completed editing, it is different to the menu item callback in that it is only called when the menu is edited. You cannot prevent completion, but you could present a dialog if the value was incorrectly adjusted.

Parameters
itemthe item that has finished editing.

Implemented in CommitCallbackObserver, and RenderingMenuMgrObserver.

◆ activeItemHasChanged()

virtual void MenuManagerObserver::activeItemHasChanged ( MenuItem )
inlinevirtual

Optionally,this method can be overridden to be told when a new item has been activated. This callback will be called after the active item is changed.

Parameters
newActive

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