DtTMNavigationMenu Class Reference

Inheritance diagram for DtTMNavigationMenu:

Public Slots
virtual void	processNavigationAction ()
	Maps menu item to type and emits navigationAction signal with that type.
virtual void	validate ()
	If we are only valid with a terrain database, disable all items if there is no terrain database present.
Public Slots inherited from DtPopupMenu
virtual void	validate ()
virtual void	menuItemDestroyed (QAction *)
virtual void	actionGroupDestroyed (DtActionGroup *)
virtual void	featureActionManagerDestroyed ()

Signals
void	navigationAction (int)
Signals inherited from DtPopupMenu
void	validateItems ()
	Sent when items want to be validated. Emitted from the validate() method.

Public Member Functions
	DtTMNavigationMenu (QWidget *parent, bool display=true)
virtual	~DtTMNavigationMenu ()
Public Member Functions inherited from DtPopupMenu
	DtPopupMenu (QWidget *parent, bool display=true)
	In your override, if you want to create the menu for right click purposes but do not want the menu to be on the main menu bar, call the parent DtPopupMenu constructor with false as the display parameter.
virtual	~DtPopupMenu ()
virtual bool	init (DtMainMenuType iType, DtMenuWidget *menu, QWidget *owner, int iPos=-1, int iID=-1)
	Supply an id to identifiy this menu item or -1 to generate a unique id.
virtual void	insertMenu (DtMenuWidget *menuWidget, int iPos=-1, int iID=-1)
virtual bool	setup (DtMenuWidget *menuWidget)
	Called from init, sets up the menu items, connections and action groups.
virtual void	preCreateMenuItems ()
virtual bool	createMenuItems ()
virtual int	id () const
virtual DtMenuItemType	typeFromAction (QAction *)
	If this object contains the specified QAction, return the type it is.
virtual DtMenuItemType	typeFromName (const QString &)
	Returns the type from the menu item name.
virtual QAction *	menuItemForType (DtMenuItemType iType)
	Returns the QAction for this type (if this menu has it)
virtual bool	hasType (DtMenuItemType iType)
	Returns true if this menu contains the specified menu item type.
virtual int	positionOfMenuItem (const DtPopupMenuItem &item)
	Returns the position of the menu item in the ordered list.
virtual int	positionOfMenuItem (DtMenuItemType iType)
virtual int	menuItemPositionOf (QAction *action)
	Returns the true menu item position of the QAction.
virtual DtMainMenuType	type () const
virtual void	setOwner (QWidget *owner)
	Accessors for owner.
virtual QWidget *	owner () const
virtual void	setEnableValidations (bool b)
	Call to always make sure all menu items are enabled with b being set to false.
virtual void	reconfigureMenu (QList< DtMenuItemType > &items, bool keep)
	This will reconfigure the menu by either keeping or removing the items in the specified list.
virtual void	updateMenuItems ()
	Update contents of menu based on any new conditions.
virtual void	seedActionGroups ()
	Goes through all the menu items and fills in the action groups list.
virtual bool	attachMenu (const QString &title, DtPopupMenu *, int iIndex=-1)
	This routine will add a DtPopupMenu as a sub menu to this menu.
bool	initialized () const
DtFeatureActionManager *	featureActionManager () const
	Accessors for featureActionManager.
virtual void	setFeatureActionManager (DtFeatureActionManager *)
void	setAddFeatures (bool)
bool	addFeatures () const
virtual QString	shortcutFor (const QString &feature) const
	Returns shortcut for specified feature.
virtual void	addShortcut (const QString &feature, const QString &shortcut)
virtual void	replaceShortcut (const QString &feature, const QString &shortcut)
virtual bool	hasShortcutOverride (const QString &feature) const
virtual bool	hasShortcut (const QString &feature) const
virtual QString	iconFor (const QString &feature, QIcon::Mode mode=QIcon::Normal, QIcon::State=QIcon::Off, bool useDefault=false)
	Returns icon for specified feature. If useDefault is true, finds default icon based on feature name.
virtual QString	menuTextForAction (QAction *)
	Returns text for the menu (or sub-menu) that contains the action.
virtual QHash< DtMenuItemType, QAction * > &	actions ()
virtual QList< QAction * >	menuActions ()
virtual const QList < DtPopupMenu * > &	attachedMenus () const
virtual DtPopupMenuItem *	insertMenuItem (DtMenuItemType iPos, const QString &featureName, DtMenuItemType iType, QString text, QString toolTip=QString::null, QString accel=QString::null, bool addSeparator=false, bool toggle=false, bool isOn=false, const QString &objectName="")
	The featureName in each of the inserts is a keyword that will be used to look up the feature in the featureActionManager for both shortcuts and icons.
virtual DtPopupMenuItem *	insertMenuItem (DtMenuItemType iPos, DtMenuItemType iType, QString text, QString toolTip=QString::null, QString accel=QString::null, bool addSeparator=false, bool toggle=false, bool isOn=false, const QString &objectName="")
	Call this version to not allow the item to be added to a user defined toolbar.
virtual DtPopupMenuItem *	insertToggleMenuItem (DtMenuItemType iBefore, const QString &featureName, DtMenuItemType iType, QString text, QString toolTip=QString::null, QString accel=QString::null, bool addSeparator=false, bool isOn=false, const QString &objectName="")
	Same as above except sets the myIsToggle flag to true which means that is will be an on/off menu item and rather than having the connection made to the "activated" signal, it will be made to the "toggled(bool)" signal.
virtual DtPopupMenuItem *	insertToggleMenuItem (DtMenuItemType iBefore, DtMenuItemType iType, QString text, QString toolTip=QString::null, QString accel=QString::null, bool addSeparator=false, bool isOn=false, const QString &objectName="")
	Call this version to not allow the item to be added to a user defined toolbar.
virtual void	addMenuItemSeparator (DtMenuItemType iGroup)
	Inserts a separator at the current create position for the specified group.
virtual void	removeMenuItem (DtMenuItemType iType)
	Removes the menu item of the specified type. If it's already created removes it immediately.
virtual bool	removeMenuGroup (const QString &gr)
	Removes the menu group and all sub-items from that group.
virtual void	removeItemAtPosition (int iPos)
	Removes the item at the specified position.
virtual void	addIcon (DtMenuItemType iType, QString icon, QIcon::Mode mode=QIcon::Normal, QIcon::State=QIcon::Off)
	Adds an icon to be added when the menu item is created.
virtual void	removeIcon (DtMenuItemType iType, QIcon::Mode mode=(QIcon::Mode)-1, QIcon::State=QIcon::Off)
	Removes an icon. If the menu item is created also removes it from the menu item.
virtual void	addGroup (DtMenuItemType iToGroup, DtMenuItemType iGroup, int iPos, bool addSep=false)
	Inserts the action group at the specified position to the specified group (use -1 to append at current position).
virtual void	removeGroup (DtMenuItemType iGroup)
	Removes group.
virtual void	addMenu (DtMainMenuType, int iPos, bool addSep)
	Inserts the menu at the specified position.
virtual void	removeMenu (DtMainMenuType iGroup)
	Removes group.
virtual void	mappingMenu (DtPopupMenu *menu, int iFlags=0)
	Call this routine if you want to map menu items.
virtual void	mapMenuItem (DtMenuItemType iType, DtPopupMenu &popupMenu, int iPos=-1, bool addSeparator=false)
	This will look at the target popup menu and take both the menu item definition and the validator map entry defined by the menu item type and add them to this menu.
virtual void	setPosition (int iPos)
	Sets the menu item position if inited. Removes then re-inserts.
virtual bool	matchesName (QString name)
	Returns true if the supplied name matches the menu name of this menu. Will take & into account.
virtual DtMenuItemType	uniqueId () const
	Returns a unique id for this menu (max + 1)
virtual QAction *	addMenuItem (DtMenuItemType &retId, const QString &featureName, const QString &item, const QString &addToMenu, bool toggle=false, QObject *actionReceiver=NULL, const char *action=NULL, QObject *validationReceiver=NULL, const char *validation=NULL, const QString &tooltip=QString::null, const QString &accelerator=QString::null, bool addSep=false)
	Adds a new menu item given the menu item, path to add, action and validator.
virtual void	appendMenuValidator (DtMenuItemType iType, QObject *vCall, const char *validator)
	Adds the specified validator to a list of validators that can be called for the menu item.
virtual void	appendMenuValidator (const QString &menu, QObject *vCall, const char *validator)
virtual bool	removeMenuItem (const QString &item)
	Removes the named menu item from the menu.
virtual void	setupFrom (DtMainMenuType iType, DtPopupMenu *, QWidget *, DtMenuWidget *w)
	Copies menu item information without creating the menu.
virtual void	renameMenuItem (DtMenuItemType iType, QString text=QString::null, QString toolTip=QString::null, QString accel=QString::null)
	Useful routines for subclasses of existing menus to rename/override default functionality.
virtual void	positionBefore (DtMenuItemType iType, DtMenuItemType iBefore)
	Repositioning of menu items.
virtual void	positionAfter (DtMenuItemType iType, DtMenuItemType iAfter)
virtual void	addActionAndValidatorForType (DtMenuItemType iType, QObject *aCall, const char *action, QObject *vCall=NULL, const char *validator=NULL)
	Adds a new action/validator pair.
virtual void	addActionForType (DtMenuItemType iType, QObject *aCall, const char *action)
virtual void	addValidatorForType (DtMenuItemType iType, QObject *vCall, const char *validator)
virtual void	addGlobalActionAndValidatorForType (DtMenuItemType iType, QObject *aCall, const char *action, QObject *vCall=NULL, const char *validator=NULL)
	Replaces on a global level the action/validator pair for the specified type.
virtual DtActionGroup *	actionGroupWithName (const QString &) const
	Returns an action (or action group) with the specified name.
virtual QAction *	actionWithName (const QString &) const
virtual void	clearMenuItems ()
	Frees memory associated with menu items. Do not call unless the menu is about to be destroyed.
virtual void	removeFeatureActions ()

Static Public Member Functions
static DtPopupMenu *	create (QWidget *parent, bool display=true)
static void	setOnlyValidWithTerrainDatabase (bool b)

Protected Member Functions
virtual QString	menuName ()
	Pure virtual overrides.
virtual bool	initMenuItems ()
	Initializes and maps the following menu items.
virtual bool	initActionGroups ()
	Creates myNavigationActionGroup.
virtual DtActionGroup *	getActionGroupForType (DtMenuItemType iType)
	If the newly created menu item is to be added to an action group, add it here.
Protected Member Functions inherited from DtPopupMenu
virtual bool	removeMenuItemAtPosition (int iPos)
	Removes the menu item at the specified position from the ordered list and the menu if it has been created.
virtual void	addNewMenuItem (DtPopupMenuItem &item, int iPos)
	Adds a new menu item to internal structures and creates if needed.
virtual QAction *	createMenuItem (const DtPopupMenuItem &item)
	Creates and returns the new menu item.
virtual void	attachMenuItems ()
	Using the mappings from type to validator and action, maps the created actions and connects them to the appropriate messages.
virtual void	attachMenuItem (const DtPopupMenuItem &item)
	Attaches a menu item based on the specific type.
virtual void	addCompletedItemsToMenu ()
	Adds the completed items to the menu.
virtual void	addAttachedMenus ()
	Adds any menus to this menu via the attachMenu command by creating them via the menu widget factory.
virtual void	setIcon (DtMenuItemType iType)
	Uses internal structures to see if this menu item needs an icon associated with it.
virtual void	attachValidators (bool b)
	Cycles through menu items and attaches/detatches validators according to flag.
virtual void	initConnections ()
	Initializes connections used for validations on this popup menu.
virtual DtPopupMenuItem *	popupMenuItem (DtMenuItemType iType, bool actionable=false)
	Returns the DtPopupMenuItem associated with a particular type.
virtual DtActionValidatorMap *	actionValidatorMapEntry (DtMenuItemType iType)
	Returns a DtActionValidatorMap associated with the particular type.
virtual void	removeOrderedMenuItem (int iPos)
	Removes the item only from the ordered list.
virtual int	addOrderedItem (const DtPopupMenuItem &item, int iPos)
	Adds an item to the ordered list. Returns the position added to in the ordered list.
virtual void	setMapMenuItemsTo (DtPopupMenu *menu)
	Set proxy menu.
virtual void	addActionGroup (DtActionGroup *)
	Adds a new action group to internal list (if does not exist)
virtual bool	matchesName (QString menu, QString name) const
virtual DtActionGroup *	internalGetActionGroupForType (DtMenuItemType type)
	Checks internal groups then checks getActionGroupForType.
virtual QAction *	addNewActionToActionGroup (const DtPopupMenuItem &item)
	Creates a new menu item and adds it to its action group.
virtual void	addAllActionsFor (DtActionGroup *)
	Given the group, looks through all menu items that return the given sub group and adds them to the group.

Protected Attributes
DtActionGroup *	myNavigationActionGroup
DtActionGroup *	myNavigationZoomActionGroup
Protected Attributes inherited from DtPopupMenu
QHash< DtMenuItemType, QAction * >	myActions
QHash< DtMenuItemType, DtPopupMenuItem >	myMenuItems
QHash< DtMenuItemType, DtActionValidatorMap >	myActionValidators
QList< DtPopupMenuItem >	myOrderedMenuItems
QHash< DtMenuItemType, QIcon >	myIcons
int	myId
bool	myCreated
bool	myInited
QWidget *	myOwner
DtMainMenuType	myType
bool	myEnableValidations
DtMenuWidget *	myMenuWidget
bool	myDisplay
QHash< DtPopupMenu *, int >	myMenuMappingList
DtPopupMenu *	myMenuItemProxy
	This will be set to a menu that is mapping us so the menuItemForType call will ask myMenuItemProxy menu rather this menu.
QList< DtActionGroup * >	myActionGroups
	These are actions groups that were created outside the menu system.
QHash< DtMenuItemType, DtActionGroup * >	myInternalGroupMappings
QList< DtPopupMenu * >	myAttachedMenus
	Menus that have been attached to this menu.
QList< DtActionGroup * >	myPendingActionGroups
	During post processing step, add menu items to parent action group or menu.
QVector< QString >	myRemovedActionGroups
	List of action groups that need to be ignored.
DtFeatureActionManager *	myFeatureActionManager
bool	myAddFeatures

Static Protected Attributes
static bool	myOnlyValidWithTerrainDatabase
Static Protected Attributes inherited from DtPopupMenu
static QHash< DtMenuItemType, DtActionValidatorMap >	myGlobalActionValidators

Additional Inherited Members
Protected Slots inherited from DtPopupMenu
virtual void	popupRemoved (QObject *)
virtual void	menuItemDestroyed ()
virtual void	actionGroupDestroyed ()

Constructor & Destructor Documentation

DtTMNavigationMenu::DtTMNavigationMenu	(	QWidget *	parent,
		bool	display = true
	)

virtual DtTMNavigationMenu::~DtTMNavigationMenu ( )

virtual

Member Function Documentation

virtual QString DtTMNavigationMenu::menuName ( )

protectedvirtual

Pure virtual overrides.

Reimplemented from DtPopupMenu.

virtual bool DtTMNavigationMenu::initMenuItems ( )

protectedvirtual

Initializes and maps the following menu items.

DtNavigationResetToGlobalViewAction to this->processNavigationAction() DtPanNorthAction to this->processNavigationAction() DtPanNorthEastAction to this->processNavigationAction() DtPanEastAction to this->processNavigationAction() DtPanSouthEastAction to this->processNavigationAction() DtPanSouthAction to this->processNavigationAction() DtPanSouthWestAction to this->processNavigationAction() DtPanWestAction to this->processNavigationAction() DtPanNorthWestAction to this->processNavigationAction() DtZoomInAction to this->processNavigationAction() DtZoomOutAction to this->processNavigationAction()

Reimplemented from DtPopupMenu.

virtual bool DtTMNavigationMenu::initActionGroups ( )

protectedvirtual

Creates myNavigationActionGroup.

Reimplemented from DtPopupMenu.

void DtTMNavigationMenu::navigationAction ( int  )

signal

virtual void DtTMNavigationMenu::processNavigationAction ( )

virtualslot

Maps menu item to type and emits navigationAction signal with that type.

virtual void DtTMNavigationMenu::validate ( )

virtualslot

If we are only valid with a terrain database, disable all items if there is no terrain database present.

static DtPopupMenu* DtTMNavigationMenu::create ( QWidget *  parent, bool  display = true  )

static

static void DtTMNavigationMenu::setOnlyValidWithTerrainDatabase ( bool  b )

static

virtual DtActionGroup* DtTMNavigationMenu::getActionGroupForType ( DtMenuItemType  iType )

protectedvirtual

If the newly created menu item is to be added to an action group, add it here.

Reimplemented from DtPopupMenu.

Member Data Documentation

DtActionGroup* DtTMNavigationMenu::myNavigationActionGroup

protected

DtActionGroup* DtTMNavigationMenu::myNavigationZoomActionGroup

protected

bool DtTMNavigationMenu::myOnlyValidWithTerrainDatabase

staticprotected

---

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

• include/tmqt/tmNavigationMenu.h