Adding a New Menu Item to PS/Workshop

<<< The PS/Workshop Interfaces

Chapters

Registering Handlers for Different Filetypes >>>

Contents

You can add a new menu item to PS/Workshop using IPSWApp::AddMenuItem or IPSWApp::AddMenuItem2. Typically this is done in CAddonMain::StartModule, which is called when the module is first loaded.

In order to add a new menu item you need to do the following:

• Define an ID to be associated with the new menu item. This ID must be unique within your module.

The easiest way of doing this is to add a new ID via the Resources Symbol dialog in Visual Studio ( View > Resource Symbols).

• Decide which class you want to handle the new menu item in. The class you choose depends on whether the menu item needs to operate at the application, document, or view level.
• Add a function to the chosen class. This function should return HRESULT.
• Modify OnCmdMsg in the chosen class to ensure that your function is called when it receives the ID.

For example, suppose that you wish to add a function called OnBlend with the ID ID_COMMAND_ON_BLEND to the CAddonDoc class. In this case, the CAddonDoc::OnCmdMsg would be as follows:

HRESULT CAddonDoc::OnCmdMsg(UINT nID, void* lpparm )
{
HRESULT hr = S_FALSE;

  // either handle the event here...
  switch( nID )
  {
  case ID_COMMAND_ON_BLEND:
    OnBlend();    
    hr = S_OK;
    break;
  default:
    break;
  }

// check if the message has already been handled
  if ( hr == S_FALSE)
  {
    // try routing this to the active view
    CAddonView* pView = GetActiveView();
    if ( pView )
      hr = pView->OnCmdMsg( nID, lpparm );
  }
  
  return hr;
}

• Add a call to AddMenuItem in CAddonMain::StartModule to add the menu item.

For example, the following code above adds an Operations menu containing a Blend command to the document level of PS/Workshop (i.e. the menu is only available when a document has been opened) . The ID ID_COMMAND_ON_BLEND is also associated with the menu item.

CComBSTR bstrMenuItem( OLESTR("&Operations\nBlend") );
HRESULT hr = m_pAppInterface->AddMenuItem(pApp, bstrMenuItem,
                   ID_COMMAND_ON_BLEND, PSW_Menu_Doc);

IPSWApp::AddMenuItem2 provides additional functionality to AddMenuItem, so that you can specify the precise position of any menu or menu item in the PS/Workshop menu bar.

[back to top]