Represents a menu class utilized by BlockStyler::Tree . More...

Inheritance diagram for NXOpen::BlockStyler::TreeListMenu:

Public Member Functions
void	AddMenuItem (int menuItemID, const NXString &menuItemText)
	Adds single menu item Created in NX7.5.0. More...

void	AddMenuItem (int menuItemID, const char *menuItemText)
	Adds single menu item Created in NX7.5.0. More...

void	AddMenuItem (int menuItemID, const NXString &menuItemText, const NXString &icon)
	Adds single menu item Created in NX7.5.0. More...

void	AddMenuItem (int menuItemID, const char menuItemText, const char icon)
	Adds single menu item Created in NX7.5.0. More...

void	AddSeparator ()
	Adds a separator Created in NX11.0.0. More...

void	AddSeperator ()
	Adds a separator More...

bool	GetItemChecked (int menuItemID)
	Gets the checked status for given menu item. More...

bool	GetItemDefault (int menuItemID)
	Gets the flag indicating whether the given menu item is default. More...

bool	GetItemDialogLaunching (int menuItemID)
	Gets the flag indicating whether the given menu item is dialog lanching. More...

bool	GetItemDisable (int menuItemID)
	Gets the flag indicating whether the given menu item is disabled. More...

bool	GetItemHidden (int menuItemID)
	Gets the flag indicating whether the given menu item is hidden. More...

NXString	GetItemIcon (int menuItemID)
	Gets the icon for given menu item. More...

NXString	GetItemText (int menuItemID)
	Gets the display text for given menu item. More...

void	SetItemChecked (int menuItemID, bool checkedStatusStatus)
	Sets the checked status for given menu item Created in NX7.5.0. More...

void	SetItemDefault (int menuItemID, bool defaultStatus)
	Sets the flag indicating whether the given menu item is default Created in NX7.5.0. More...

void	SetItemDialogLaunching (int menuItemID, bool dialogLaunchingStaus)
	Sets the flag indicating whether the given menu item is dialog lanching Created in NX7.5.0. More...

void	SetItemDisable (int menuItemID, bool disableStatus)
	Sets the flag indicating whether the given menu item is disabled Created in NX7.5.0. More...

void	SetItemHidden (int menuItemID, bool hiddenStatus)
	Sets the flag indicating whether the given menu item is hidden Created in NX7.5.0. More...

void	SetItemIcon (int menuItemID, const NXString &icon)
	Sets the icon for given menu item Created in NX7.5.0. More...

void	SetItemIcon (int menuItemID, const char *icon)
	Sets the icon for given menu item Created in NX7.5.0. More...

void	SetItemText (int menuItemID, const NXString &text)
	Sets the display text for given menu item Created in NX7.5.0. More...

void	SetItemText (int menuItemID, const char *text)
	Sets the display text for given menu item Created in NX7.5.0. More...

void	SetSubMenu (int menuItemID, NXOpen::BlockStyler::TreeListMenu *subMenu)
	Sets a submenu. More...

virtual	~TreeListMenu ()
	Frees the object from memory. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents a menu class utilized by BlockStyler::Tree .

Refer to BlockStyler::Tree::CreateMenu to create the menu.

Created in NX7.5.0.

Constructor & Destructor Documentation

virtual NXOpen::BlockStyler::TreeListMenu::~TreeListMenu ( )

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object.
Created in NX7.5.0.

License requirements : None

Member Function Documentation

void NXOpen::BlockStyler::TreeListMenu::AddMenuItem	(	int	menuItemID,
		const NXString &	menuItemText
	)

Adds single menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Unique identifier for the menu item being added
menuItemText	Display text for menu item being added

void NXOpen::BlockStyler::TreeListMenu::AddMenuItem	(	int	menuItemID,
		const char *	menuItemText
	)

Adds single menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Unique identifier for the menu item being added
menuItemText	Display text for menu item being added

void NXOpen::BlockStyler::TreeListMenu::AddMenuItem	(	int	menuItemID,
		const NXString &	menuItemText,
		const NXString &	icon
	)

Adds single menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Unique identifier for the menu item being added
menuItemText	Display text for menu item being added
icon	Icon for menu item being added

void NXOpen::BlockStyler::TreeListMenu::AddMenuItem	(	int	menuItemID,
		const char *	menuItemText,
		const char *	icon
	)

Adds single menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Unique identifier for the menu item being added
menuItemText	Display text for menu item being added
icon	Icon for menu item being added

void NXOpen::BlockStyler::TreeListMenu::AddSeparator ( )

Adds a separator
Created in NX11.0.0.

License requirements : None

void NXOpen::BlockStyler::TreeListMenu::AddSeperator ( )

Adds a separator

Deprecated:: Deprecated in NX11.0.0.

Use BlockStyler::TreeListMenu::AddSeparator instead.

Created in NX7.5.0.

License requirements : None

bool NXOpen::BlockStyler::TreeListMenu::GetItemChecked ( int menuItemID )

Gets the checked status for given menu item.

Returns: Status
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

bool NXOpen::BlockStyler::TreeListMenu::GetItemDefault ( int menuItemID )

Gets the flag indicating whether the given menu item is default.

Returns: Status
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

bool NXOpen::BlockStyler::TreeListMenu::GetItemDialogLaunching ( int menuItemID )

Gets the flag indicating whether the given menu item is dialog lanching.

Returns: Status
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

bool NXOpen::BlockStyler::TreeListMenu::GetItemDisable ( int menuItemID )

Gets the flag indicating whether the given menu item is disabled.

Returns: Status
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

bool NXOpen::BlockStyler::TreeListMenu::GetItemHidden ( int menuItemID )

Gets the flag indicating whether the given menu item is hidden.

Returns: Status
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

NXString NXOpen::BlockStyler::TreeListMenu::GetItemIcon ( int menuItemID )

Gets the icon for given menu item.

Returns: Display text
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

NXString NXOpen::BlockStyler::TreeListMenu::GetItemText ( int menuItemID )

Gets the display text for given menu item.

Returns: Display text
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID Menu-item ID

void NXOpen::BlockStyler::TreeListMenu::SetItemChecked	(	int	menuItemID,
		bool	checkedStatusStatus
	)

Sets the checked status for given menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
checkedStatusStatus	Status

void NXOpen::BlockStyler::TreeListMenu::SetItemDefault	(	int	menuItemID,
		bool	defaultStatus
	)

Sets the flag indicating whether the given menu item is default
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
defaultStatus	Status

void NXOpen::BlockStyler::TreeListMenu::SetItemDialogLaunching	(	int	menuItemID,
		bool	dialogLaunchingStaus
	)

Sets the flag indicating whether the given menu item is dialog lanching
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
dialogLaunchingStaus	Status

void NXOpen::BlockStyler::TreeListMenu::SetItemDisable	(	int	menuItemID,
		bool	disableStatus
	)

Sets the flag indicating whether the given menu item is disabled
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
disableStatus	Status

void NXOpen::BlockStyler::TreeListMenu::SetItemHidden	(	int	menuItemID,
		bool	hiddenStatus
	)

Sets the flag indicating whether the given menu item is hidden
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
hiddenStatus	Status

void NXOpen::BlockStyler::TreeListMenu::SetItemIcon	(	int	menuItemID,
		const NXString &	icon
	)

Sets the icon for given menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
icon	Display text

void NXOpen::BlockStyler::TreeListMenu::SetItemIcon	(	int	menuItemID,
		const char *	icon
	)

Sets the icon for given menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
icon	Display text

void NXOpen::BlockStyler::TreeListMenu::SetItemText	(	int	menuItemID,
		const NXString &	text
	)

Sets the display text for given menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
text	Display text

void NXOpen::BlockStyler::TreeListMenu::SetItemText	(	int	menuItemID,
		const char *	text
	)

Sets the display text for given menu item
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu-item ID
text	Display text

void NXOpen::BlockStyler::TreeListMenu::SetSubMenu	(	int	menuItemID,
		NXOpen::BlockStyler::TreeListMenu *	subMenu
	)

Sets a submenu.

Submenu can be created using BlockStyler::Tree::CreateMenu method
Created in NX7.5.0.

License requirements : None

Parameters

menuItemID	Menu Item ID of menu item on which submenu is supposed to be set.
subMenu	Menu to be added as submenu

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

BlockStyler_TreeListMenu.hxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation