Public Member Functions | Private Attributes

XAP_Menu_Factory Class Reference

#include <xap_Menu_Layouts.h>

List of all members.

Public Member Functions

 XAP_Menu_Factory (XAP_App *pApp)
 ~XAP_Menu_Factory (void)
EV_Menu_Layout * CreateMenuLayout (const char *szName)
const char * FindContextMenu (EV_EditMouseContext emc)
XAP_Menu_Id addNewMenuAfter (const char *szMenu, const char *szLanguage, const XAP_Menu_Id afterID, EV_Menu_LayoutFlags flags, XAP_Menu_Id newID=0)
XAP_Menu_Id addNewMenuAfter (const char *szMenu, const char *szLanguage, const char *szAfter, EV_Menu_LayoutFlags flags, XAP_Menu_Id menuID=0)
XAP_Menu_Id addNewMenuBefore (const char *szMenu, const char *szLanguage, const XAP_Menu_Id beforeID, EV_Menu_LayoutFlags flags, XAP_Menu_Id newID=0)
XAP_Menu_Id addNewMenuBefore (const char *szMenu, const char *szLanguage, const char *szBefore, EV_Menu_LayoutFlags flags, XAP_Menu_Id menuID=0)
XAP_Menu_Id getNewID (void)
XAP_Menu_Id removeMenuItem (const char *szMenu, const char *szLanguage, XAP_Menu_Id nukeID)
XAP_Menu_Id removeMenuItem (const char *szMenu, const char *szLanguage, const char *szNuke)
void resetMenusToDefault (void)
UT_uint32 GetMenuLabelSetLanguageCount (void)
const char * GetNthMenuLabelLanguageName (UT_uint32 ndx)
EV_Menu_LabelSet * CreateMenuLabelSet (const char *szLanguage_)
bool buildMenuLabelSet (const char *szLanguage_)
bool buildBuiltInMenuLabelSet (EV_Menu_LabelSet *&pLabelSet)
bool addNewLabel (const char *szMenu, XAP_Menu_Id newID, const char *szNewLabel, const char *szNewTooltip)
bool removeLabel (const char *szMenu, XAP_Menu_Id nukeID)
void resetLabelsToDefault (void)
EV_EditMouseContext createContextMenu (const char *szMenu)
void removeContextMenu (EV_EditMouseContext menuID)

Private Attributes

UT_GenericVector< _vectt * > m_vecTT
XAP_App * m_pApp
EV_Menu_LabelSet * m_pLabelSet
EV_Menu_LabelSet * m_pEnglishLabelSet
XAP_Menu_Id m_maxID
XAP_StringSet * m_pBSS
EV_EditMouseContext m_NextContext

Constructor & Destructor Documentation

XAP_Menu_Factory::XAP_Menu_Factory ( XAP_App *  pApp  ) 

Load these cleverly constructed static tables into vectors so they can be manipulated dynamically.

References UT_GenericVector< T >::addItem(), UT_GenericVector< T >::clear(), m_NextContext, m_pBSS, m_pEnglishLabelSet, and m_vecTT.

XAP_Menu_Factory::~XAP_Menu_Factory ( void   ) 

References DELETEP, m_pBSS, m_pEnglishLabelSet, m_pLabelSet, m_vecTT, and UT_VECTOR_SPARSEPURGEALL.

Member Function Documentation

bool XAP_Menu_Factory::addNewLabel ( const char *  szMenu,
XAP_Menu_Id  newID,
const char *  szNewName,
const char *  szNewTooltip 
)

afterID has just been created. All labels of value equal or greater must be incremented

References EV_Menu_LabelSet::addLabel(), and m_pLabelSet.

Referenced by AbiGimp_addToMenus(), AbiGOffice_addToMenus(), AbiMathView_addToMenus(), addToMenus(), AiksaurusABI_addToMenus(), BabelFish_addToMenus(), GR_GOChartManager::buildContextualMenu(), FreeTranslation_addToMenus(), GDA_addToMenus(), GDict_addToMenus(), Google_addToMenus(), AP_CocoaPlugin_ContextMenuItem::initWithLabel:, LoadBindings_registerMethod(), Ots_addToMenus(), Presentation_registerMethod(), s_abicollab_add_menus(), URLDict_addToMenus(), and Wikipedia_addToMenus().

XAP_Menu_Id XAP_Menu_Factory::addNewMenuAfter ( const char *  szMenu,
const char *  szLanguage,
const XAP_Menu_Id  afterID,
EV_Menu_LayoutFlags  flags,
XAP_Menu_Id  newID = 0 
)

References UT_GenericVector< T >::getItemCount(), getNewID(), UT_GenericVector< T >::getNthItem(), _vectt::insertItemAt(), _lt::m_flags, _lt::m_id, _vectt::m_name, m_vecTT, UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

Referenced by AbiGimp_addToMenus(), AbiGOffice_addToMenus(), AbiMathView_addToMenus(), addToMenus(), AiksaurusABI_addToMenus(), BabelFish_addToMenus(), GR_GOChartManager::buildContextualMenu(), FreeTranslation_addToMenus(), GDA_addToMenus(), GDict_addToMenus(), Google_addToMenus(), AP_CocoaPlugin_ContextMenuItem::initWithLabel:, LoadBindings_registerMethod(), Ots_addToMenus(), Presentation_registerMethod(), s_abicollab_add_menus(), URLDict_addToMenus(), and Wikipedia_addToMenus().

XAP_Menu_Id XAP_Menu_Factory::addNewMenuAfter ( const char *  szMenu,
const char *  szLanguage,
const char *  szAfter,
EV_Menu_LayoutFlags  flags,
XAP_Menu_Id  menuID = 0 
)

References buildBuiltInMenuLabelSet(), EV_searchMenuLabel(), UT_GenericVector< T >::getItemCount(), getNewID(), UT_GenericVector< T >::getNthItem(), _vectt::insertItemAt(), _lt::m_flags, _lt::m_id, _vectt::m_name, m_pEnglishLabelSet, m_pLabelSet, m_vecTT, UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

XAP_Menu_Id XAP_Menu_Factory::addNewMenuBefore ( const char *  szMenu,
const char *  szLanguage,
const XAP_Menu_Id  beforeID,
EV_Menu_LayoutFlags  flags,
XAP_Menu_Id  newID = 0 
)

References UT_GenericVector< T >::getItemCount(), getNewID(), UT_GenericVector< T >::getNthItem(), _vectt::insertItemAt(), _vectt::insertItemBefore(), _lt::m_flags, _lt::m_id, _vectt::m_name, m_vecTT, UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

Referenced by AbiGOffice_addToMenus(), GR_GOChartManager::buildContextualMenu(), Presentation_registerMethod(), and s_abicollab_add_menus().

XAP_Menu_Id XAP_Menu_Factory::addNewMenuBefore ( const char *  szMenu,
const char *  szLanguage,
const char *  szBefore,
EV_Menu_LayoutFlags  flags,
XAP_Menu_Id  menuID = 0 
)

References buildBuiltInMenuLabelSet(), EV_searchMenuLabel(), UT_GenericVector< T >::getItemCount(), getNewID(), UT_GenericVector< T >::getNthItem(), _vectt::insertItemAt(), _vectt::insertItemBefore(), _lt::m_flags, _lt::m_id, _vectt::m_name, m_pEnglishLabelSet, m_pLabelSet, m_vecTT, UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

bool XAP_Menu_Factory::buildBuiltInMenuLabelSet ( EV_Menu_LabelSet *&  pLabelSet  ) 

Build a builtin label set in memory that can be used by plugins to find where to put menu items in non-Enmgish locales. Do tricky reference to pointer here....

This file defines the set of Id's used for all menu-related

things. Each Id defines a conceptual unit which may be

used on one or more menus or not at all.

References AP_MENU_ID__BOGUS1__, m_pApp, and m_pBSS.

Referenced by addNewMenuAfter(), addNewMenuBefore(), and removeMenuItem().

bool XAP_Menu_Factory::buildMenuLabelSet ( const char *  szLanguage_  ) 

Build a label set in memory that can be cloned by frames and added to by plugins.

This file defines the set of Id's used for all menu-related

things. Each Id defines a conceptual unit which may be

used on one or more menus or not at all.

References AP_MENU_ID__BOGUS1__, XAP_App::getApp(), XAP_App::getStringSet(), m_pLabelSet, and UT_DEBUGMSG.

EV_EditMouseContext XAP_Menu_Factory::createContextMenu ( const char *  szMenu  ) 

References UT_GenericVector< T >::addItem(), AP_MENU_ID__BOGUS1__, UT_GenericVector< T >::getNthItem(), _tt::m_emc, _tt::m_lt, _tt::m_name, m_NextContext, _tt::m_nrEntries, m_vecTT, and UT_GenericVector< T >::setNthItem().

Referenced by GR_GOChartManager::buildContextualMenu(), and Presentation_registerMethod().

EV_Menu_LabelSet * XAP_Menu_Factory::CreateMenuLabelSet ( const char *  szLanguage_  ) 

This file defines the set of Id's used for all menu-related

things. Each Id defines a conceptual unit which may be

used on one or more menus or not at all.

References AP_MENU_ID__BOGUS1__, XAP_App::getApp(), XAP_App::getStringSet(), m_pLabelSet, and UT_DEBUGMSG.

Referenced by EV_Menu::EV_Menu().

EV_Menu_Layout * XAP_Menu_Factory::CreateMenuLayout ( const char *  szName  ) 

References UT_GenericVector< T >::getItemCount(), _vectt::getNrEntries(), _vectt::getNth_lt(), UT_GenericVector< T >::getNthItem(), _lt::m_flags, _lt::m_id, _vectt::m_name, m_vecTT, EV_Menu_Layout::setLayoutItem(), UT_ASSERT_HARMLESS, and UT_return_val_if_fail.

Referenced by EV_Menu::EV_Menu().

const char * XAP_Menu_Factory::FindContextMenu ( EV_EditMouseContext  emc  ) 

References UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), _vectt::m_emc, _vectt::m_name, m_vecTT, UT_ASSERT_HARMLESS, UT_DEBUGMSG, and UT_NOT_IMPLEMENTED.

Referenced by Defun1(), Presentation_context(), and s_doContextMenu_no_move().

UT_uint32 XAP_Menu_Factory::GetMenuLabelSetLanguageCount ( void   ) 
XAP_Menu_Id XAP_Menu_Factory::getNewID ( void   ) 

References UT_GenericVector< T >::getItemCount(), _vectt::getNrEntries(), _vectt::getNth_lt(), UT_GenericVector< T >::getNthItem(), _lt::m_id, m_maxID, and m_vecTT.

Referenced by addNewMenuAfter(), addNewMenuBefore(), and addToMenus().

const char * XAP_Menu_Factory::GetNthMenuLabelLanguageName ( UT_uint32  ndx  ) 

References EV_Menu_LabelSet::getLanguage(), and m_pLabelSet.

void XAP_Menu_Factory::removeContextMenu ( EV_EditMouseContext  menuID  ) 

References UT_GenericVector< T >::deleteNthItem(), DELETEP, UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), _vectt::m_emc, m_vecTT, UT_ASSERT_HARMLESS, and UT_SHOULD_NOT_HAPPEN.

Referenced by GR_GOChartManager::removeContextualMenu().

bool XAP_Menu_Factory::removeLabel ( const char *  szMenu,
XAP_Menu_Id  nukeID 
)
XAP_Menu_Id XAP_Menu_Factory::removeMenuItem ( const char *  szMenu,
const char *  szLanguage,
const char *  szNuke 
)

Remove the menu item named szNuke from the menu labelled szMenu in the Language set szLanguage

References buildBuiltInMenuLabelSet(), EV_searchMenuLabel(), UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), _vectt::m_name, m_pEnglishLabelSet, m_pLabelSet, m_vecTT, _vectt::removeItem(), UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

XAP_Menu_Id XAP_Menu_Factory::removeMenuItem ( const char *  szMenu,
const char *  szLanguage,
XAP_Menu_Id  nukeID 
)

Remove the menu item with id nukeID from the menu labelled szMenu in the Language set szLanguage

References UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), _vectt::m_name, m_vecTT, _vectt::removeItem(), UT_ASSERT_HARMLESS, UT_return_val_if_fail, and UT_SHOULD_NOT_HAPPEN.

Referenced by AbiGimp_RemoveFromMenus(), AbiGOffice_removeFromMenus(), AbiMathView_removeFromMenus(), AikSaurusABI_RemoveFromMenus(), BabelFish_RemoveFromMenus(), AP_CocoaPlugin_ContextMenuItem::dealloc, FreeTranslation_RemoveFromMenus(), GDA_removeFromMenus(), GDict_removeFromMenus(), Google_removeFromMenus(), LoadBindings_RemoveFromMethods(), Ots_removeFromMenus(), Presentation_RemoveFromMethods(), removeFromMenus(), s_abicollab_remove_menus(), URLDict_removeFromMenus(), and Wikipedia_removeFromMenus().

void XAP_Menu_Factory::resetLabelsToDefault ( void   ) 
void XAP_Menu_Factory::resetMenusToDefault ( void   ) 

References UT_GenericVector< T >::addItem(), UT_GenericVector< T >::clear(), m_vecTT, and UT_VECTOR_PURGEALL.

Member Data Documentation

XAP_Menu_Id XAP_Menu_Factory::m_maxID [private]

Referenced by getNewID().

EV_EditMouseContext XAP_Menu_Factory::m_NextContext [private]

Referenced by createContextMenu(), and XAP_Menu_Factory().

XAP_App* XAP_Menu_Factory::m_pApp [private]

Referenced by buildBuiltInMenuLabelSet().

XAP_StringSet* XAP_Menu_Factory::m_pBSS [private]

Referenced by buildBuiltInMenuLabelSet(), XAP_Menu_Factory(), and ~XAP_Menu_Factory().

EV_Menu_LabelSet* XAP_Menu_Factory::m_pEnglishLabelSet [private]

Referenced by addNewMenuAfter(), addNewMenuBefore(), removeMenuItem(), XAP_Menu_Factory(), and ~XAP_Menu_Factory().

EV_Menu_LabelSet* XAP_Menu_Factory::m_pLabelSet [private]

Referenced by addNewLabel(), addNewMenuAfter(), addNewMenuBefore(), buildMenuLabelSet(), CreateMenuLabelSet(), GetNthMenuLabelLanguageName(), removeMenuItem(), and ~XAP_Menu_Factory().

UT_GenericVector<_vectt *> XAP_Menu_Factory::m_vecTT [private]

Referenced by addNewMenuAfter(), addNewMenuBefore(), createContextMenu(), CreateMenuLayout(), FindContextMenu(), getNewID(), removeContextMenu(), removeMenuItem(), resetMenusToDefault(), XAP_Menu_Factory(), and ~XAP_Menu_Factory().

The documentation for this class was generated from the following files:
Generated on Sun Feb 14 2021 for AbiWord by  doxygen 1.7.1