#include <xap_Toolbar_Layouts.h>

Public Member Functions
	XAP_Toolbar_Factory (XAP_App *pApp)
	~XAP_Toolbar_Factory (void)
EV_Toolbar_Layout *	CreateToolbarLayout (const char *szName)
EV_Toolbar_Layout *	DuplicateToolbarLayout (const char *szName)
void	restoreToolbarLayout (EV_Toolbar_Layout *pTB)
bool	addIconBefore (const char *szName, XAP_Toolbar_Id newId, XAP_Toolbar_Id beforeId)
bool	addIconAfter (const char *szName, XAP_Toolbar_Id newId, XAP_Toolbar_Id afterId)
bool	addIconAtEnd (const char *szName, XAP_Toolbar_Id newId)
bool	removeIcon (const char *szName, XAP_Toolbar_Id nukeId)
bool	saveToolbarsInCurrentScheme (void)
bool	restoreToolbarsFromCurrentScheme (void)
const UT_GenericVector < UT_UTF8String * > &	getToolbarNames (void)
UT_uint32	countToolbars (void) const
const gchar *	prefKeyForToolbar (UT_uint32 t) const
Private Attributes
UT_GenericVector < XAP_Toolbar_Factory_vec * >	m_vecTT
XAP_App *	m_pApp
UT_GenericVector< UT_UTF8String * >	m_tbNames

Constructor & Destructor Documentation

XAP_Toolbar_Factory::XAP_Toolbar_Factory ( XAP_App * pApp )

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

XAP_Toolbar_Factory::~XAP_Toolbar_Factory ( void )

References m_tbNames, m_vecTT, and UT_VECTOR_PURGEALL.

Member Function Documentation

bool XAP_Toolbar_Factory::addIconAfter	(	const char *	szName,
		XAP_Toolbar_Id	newId,
		XAP_Toolbar_Id	afterId
	)

References UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getToolbarName(), XAP_Toolbar_Factory_vec::insertItemAfter(), XAP_Toolbar_Factory_lt::m_flags, XAP_Toolbar_Factory_lt::m_id, m_vecTT, and UT_ASSERT_HARMLESS.

bool XAP_Toolbar_Factory::addIconAtEnd	(	const char *	szName,
		XAP_Toolbar_Id	newId
	)

This method adds an icon at the last position on a toolbar.

References UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getToolbarName(), XAP_Toolbar_Factory_vec::insertLastItem(), XAP_Toolbar_Factory_lt::m_flags, XAP_Toolbar_Factory_lt::m_id, m_vecTT, and UT_ASSERT_HARMLESS.

bool XAP_Toolbar_Factory::addIconBefore	(	const char *	szName,
		XAP_Toolbar_Id	newId,
		XAP_Toolbar_Id	beforeId
	)

This method inserts an icon before the icon number beforeId

References UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getToolbarName(), XAP_Toolbar_Factory_vec::insertItemBefore(), XAP_Toolbar_Factory_lt::m_flags, XAP_Toolbar_Factory_lt::m_id, m_vecTT, and UT_ASSERT_HARMLESS.

UT_uint32 XAP_Toolbar_Factory::countToolbars ( void ) const

Returns the number of toolbars in the factory.

References UT_GenericVector< T >::getItemCount(), and m_vecTT.

Referenced by AP_Dialog_Options::_populateWindowData(), and AP_Dialog_Options::_storeWindowData().

EV_Toolbar_Layout * XAP_Toolbar_Factory::CreateToolbarLayout ( const char * szName )

References UT_GenericVector< T >::getItemCount(), XAP_Toolbar_Factory_vec::getNrEntries(), XAP_Toolbar_Factory_vec::getNth_lt(), UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getToolbarName(), XAP_Toolbar_Factory_lt::m_flags, XAP_Toolbar_Factory_lt::m_id, m_vecTT, EV_Toolbar_Layout::setLayoutItem(), UT_ASSERT_HARMLESS, and UT_return_val_if_fail.

Referenced by DuplicateToolbarLayout(), and EV_Toolbar::EV_Toolbar().

EV_Toolbar_Layout * XAP_Toolbar_Factory::DuplicateToolbarLayout ( const char * szName )

References CreateToolbarLayout().

const UT_GenericVector< UT_UTF8String * > & XAP_Toolbar_Factory::getToolbarNames ( void )

Get the toolbar names.

Note:: return value should NOT be copied.... because UT_Vector doesn't like copy for now.

References UT_GenericVector< T >::addItem(), UT_GenericVector< T >::clear(), UT_GenericVector< T >::getItemCount(), XAP_Toolbar_Factory_vec::getLabelStringID(), UT_GenericVector< T >::getNthItem(), XAP_App::getStringSet(), XAP_StringSet::getValueUTF8(), label, m_pApp, m_tbNames, m_vecTT, s, and UT_VECTOR_PURGEALL.

Referenced by Defun_EV_GetMenuItemComputedLabel_Fn().

const gchar * XAP_Toolbar_Factory::prefKeyForToolbar ( UT_uint32 t ) const

Return the Prefs key for the toolbar.

References UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getPrefKey(), and m_vecTT.

Referenced by AP_Dialog_Options::_populateWindowData(), and AP_Dialog_Options::_storeWindowData().

bool XAP_Toolbar_Factory::removeIcon	(	const char *	szName,
		XAP_Toolbar_Id	nukeId
	)

References UT_GenericVector< T >::getItemCount(), UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getToolbarName(), m_vecTT, XAP_Toolbar_Factory_vec::removeToolbarId(), and UT_ASSERT_HARMLESS.

void XAP_Toolbar_Factory::restoreToolbarLayout ( EV_Toolbar_Layout * pTB )

This restores a toolbar layout in memory to a version previously constructed and used as Toolbar.

References UT_String::c_str(), DELETEP, UT_GenericVector< T >::getItemCount(), EV_Toolbar_Layout::getName(), UT_GenericVector< T >::getNthItem(), XAP_Toolbar_Factory_vec::getToolbarName(), m_vecTT, UT_GenericVector< T >::setNthItem(), UT_ASSERT_HARMLESS, and UT_return_if_fail.

bool XAP_Toolbar_Factory::restoreToolbarsFromCurrentScheme ( void )

This method restores the toolbar layouts from the current preference scheme. There are 3 generic keys. The Number of entries ((Base Key for Nr entries)+(TB name)) The ith ID ((Base Key for id)+(TB name)+(i)) The ith Flag ((Base Key for flag)+(TB name)+(i))

References XAP_Toolbar_Factory_vec::add_lt(), UT_GenericVector< T >::addItem(), UT_String::c_str(), UT_GenericVector< T >::clear(), gchar, EV_Toolbar_ActionSet::getAction(), XAP_Prefs::getCurrentScheme(), XAP_App::getPrefs(), XAP_App::getToolbarActionSet(), XAP_PrefsScheme::getValue(), XAP_Toolbar_Factory_lt::m_flags, XAP_Toolbar_Factory_lt::m_id, XAP_Toolbar_Factory_tt::m_name, m_pApp, m_vecTT, UT_DEBUGMSG, UT_return_val_if_fail, and UT_VECTOR_PURGEALL.

bool XAP_Toolbar_Factory::saveToolbarsInCurrentScheme ( void )

This method saves the current toolbar layouts in the current preference scheme. There are 3 generic keys. The Number of entries ((Base Key for Nr entries)+(TB name)) The ith ID ((Base Key for id)+(TB name)+(i)) The ith Flag ((Base Key for flag)+(TB name)+(i))

References UT_String::c_str(), gchar, XAP_Prefs::getCurrentScheme(), UT_GenericVector< T >::getItemCount(), XAP_Toolbar_Factory_vec::getNrEntries(), XAP_Toolbar_Factory_vec::getNth_lt(), UT_GenericVector< T >::getNthItem(), XAP_App::getPrefs(), XAP_Toolbar_Factory_vec::getToolbarName(), XAP_Toolbar_Factory_lt::m_flags, XAP_Toolbar_Factory_lt::m_id, m_pApp, m_vecTT, XAP_PrefsScheme::setValue(), and UT_DEBUGMSG.

Member Data Documentation

XAP_App* XAP_Toolbar_Factory::m_pApp [private]

Referenced by getToolbarNames(), restoreToolbarsFromCurrentScheme(), and saveToolbarsInCurrentScheme().

UT_GenericVector<UT_UTF8String*> XAP_Toolbar_Factory::m_tbNames [private]

Referenced by getToolbarNames(), and ~XAP_Toolbar_Factory().

UT_GenericVector<XAP_Toolbar_Factory_vec*> XAP_Toolbar_Factory::m_vecTT [private]

Referenced by addIconAfter(), addIconAtEnd(), addIconBefore(), countToolbars(), CreateToolbarLayout(), getToolbarNames(), prefKeyForToolbar(), removeIcon(), restoreToolbarLayout(), restoreToolbarsFromCurrentScheme(), saveToolbarsInCurrentScheme(), XAP_Toolbar_Factory(), and ~XAP_Toolbar_Factory().

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

XAP_Toolbar_Factory Class Reference

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation