#include <ap_Dialog_Lists.h>

Inheritance diagram for AP_Dialog_Lists:

Public Types
enum	tAnswer { a_OK, a_QUIT, a_CLOSE }
Public Member Functions
	AP_Dialog_Lists (XAP_DialogFactory *pDlgFactory, XAP_Dialog_Id id)
virtual	~AP_Dialog_Lists (void)
AP_Dialog_Lists::tAnswer	getAnswer (void) const
void	setAnswer (AP_Dialog_Lists::tAnswer ans)
void	StartList (void)
void	StopList (void)
void	Apply (void)
void	fillDialogFromBlock (void)
void	fillDialogFromVector (UT_GenericVector< const gchar * > *inVec)
void	PopulateDialogData (void)
void	fillFakeLabels (void)
bool	isLastOnLevel (void)
gchar *	getListStyleString (UT_uint32 iListType)
UT_uint32	decodeListType (char *listformat)
UT_sint32	findVecItem (UT_GenericVector< const gchar * > v, const char key)
void	fillUncustomizedValues (void)
UT_uint32	getID (void)
UT_uint32	getStoredID (void)
fl_AutoNumPtr	getAutoNum (void) const
fl_BlockLayout *	getBlock (void) const
UT_uint32	getTick (void)
const UT_Vector *	getOutProps (void) const
void	setTick (UT_uint32 iTick)
bool	isDirty (void) const
void	setDirty (void)
void	clearDirty (void)
AV_View *	getAvView (void)
void	generateFakeLabels (void)
UT_UCSChar *	getListLabel (UT_sint32 itemNo)
virtual void	event_PreviewAreaExposed ()
virtual void	_createPreviewFromGC (GR_Graphics *gc, UT_uint32 width, UT_uint32 height)
void	setModal (void)
bool	isModal (void) const
Static Public Member Functions
static UT_sint32	findVecItem (const PP_PropertyVector &v, const char *key)
	XXX this should be moved out of here.
Protected Member Functions
virtual XAP_String_Id	getWindowTitleStringId ()
	SET_GATHER (iLocalTick, UT_uint32)
	SET_GATHER (iStartValue, UT_uint32)
	SET_GATHER (newStartValue, UT_uint32)
	SET_GATHER (fAlign, float)
	SET_GATHER (fIndent, float)
	SET_GATHER (bStartNewList, bool)
	SET_GATHER (bApplyToCurrent, bool)
	SET_GATHER (bResumeList, bool)
	SET_GATHER (bisCustomized, bool)
	SET_GATHER (isListAtPoint, bool)
	SET_GATHER (bguiChanged, bool)
	SET_GATHER (NewListType, FL_ListType)
	SET_GATHER (DocListType, FL_ListType)
	SET_GATHER (iLevel, UT_uint32)
	SET_GATHER (pView, FV_View *)
void	copyCharToDelim (const std::string &pszDelim)
const std::string &	getDelim (void) const
void	copyCharToDecimal (const std::string &pszDecimal)
const std::string &	getDecimal (void) const
void	copyCharToFont (const std::string &pszFont)
const std::string &	getFont (void)
void	copyCharToWindowName (const char *pszName)
const char *	getWindowName () const
AP_Lists_preview *	getListsPreview ()
void	setCurrentFold (UT_sint32 iLevel)
UT_sint32	getCurrentFold (void)
virtual void	setFoldLevelInGUI (void)=0
virtual bool	isPageLists (void)=0
void	setFoldingLevelChanged (bool b)
Private Attributes
FV_View *	m_pView
tAnswer	m_Answer
bool	m_isListAtPoint
bool	m_previousListExistsAtPoint
UT_UCSChar	m_curListLabel [100]
UT_UCSChar	m_newListLabel [100]
FL_ListType	m_NewListType
std::string	m_pszDelim
std::string	m_pszDecimal
std::string	m_pszFont
float	m_fAlign
float	m_fIndent
UT_uint32	m_iLevel
UT_uint32	m_iStartValue
UT_uint32	m_iWidth
UT_uint32	m_iHeight
UT_uint32	m_iLocalTick
UT_uint32	m_curStartValue
UT_uint32	m_newStartValue
UT_uint32	m_curListLevel
UT_uint32	m_newListLevel
UT_uint32	m_iID
FL_ListType	m_DocListType
bool	m_bStartList
bool	m_bStartNewList
bool	m_bApplyToCurrent
bool	m_bResumeList
bool	m_bisCustomized
bool	m_bguiChanged
AP_Preview_Paragraph *	m_paragraphPreview
AP_Lists_preview *	m_pListsPreview
fl_Layout *	m_pFakeLayout [4]
pf_Frag_Strux *	m_pFakeSdh [4]
fl_AutoNumPtr	m_pFakeAuto
PD_Document *	m_pFakeDoc
bool	m_bDirty
bool	m_bIsModal
UT_sint32	m_iCurrentLevel
UT_Vector	m_OutProps
UT_String	m_Output [5]
bool	m_bFoldingLevelChanged

Member Enumeration Documentation

enum AP_Dialog_Lists::tAnswer

Enumerator:

a_OK
a_QUIT
a_CLOSE

Reimplemented from AP_Dialog_Modeless.

Constructor & Destructor Documentation

AP_Dialog_Lists::AP_Dialog_Lists	(	XAP_DialogFactory *	pDlgFactory,
		XAP_Dialog_Id	id
	)

References m_curListLabel, m_newListLabel, m_pFakeLayout, m_pFakeSdh, m_pszDecimal, m_pszDelim, m_pszFont, and AP_Dialog_Modeless::m_WindowName.

AP_Dialog_Lists::~AP_Dialog_Lists ( void ) [virtual]

References DELETEP, m_pFakeDoc, m_pFakeLayout, m_pFakeSdh, m_pListsPreview, and UNREFP.

Member Function Documentation

void AP_Dialog_Lists::_createPreviewFromGC	(	GR_Graphics *	gc,
		UT_uint32	width,
		UT_uint32	height
	)			`[virtual]`

Create the preview from the Graphics Context provided by the platform code.

Parameters:

	gc	the Platform Graphics Context cast into the a XP handle.
	width	the width of the gc
	height	the height of the gc

References DELETEP, generateFakeLabels(), getBlock(), fl_BlockLayout::isListItem(), m_iHeight, m_isListAtPoint, m_iWidth, m_NewListType, m_pListsPreview, XAP_Preview::setWindowSize(), and UT_return_if_fail.

Referenced by AP_Win32Dialog_Lists::_onInitDialog(), AP_UnixDialog_Lists::runModal(), AP_CocoaDialog_Lists::runModal, AP_UnixDialog_Lists::runModeless(), and AP_CocoaDialog_Lists::runModeless.

void AP_Dialog_Lists::Apply ( void )

This method Does the stuff requested on the "action" button, "Apply" in the Modeless dialog and "OK" in the Modal dialog. Read comments with for all the stuff that can happen.

Just to make things even more confusing this method is also used in a Modal mannor by the styles dialog. This method is called when the users clicks "OK" on the modal dialog. When that happens we fill an output vector with all the properties currently defined.

If the "Apply to current" radio buton is chosen we have two options. 1. If "No list" is chosen we stop the current list at on this block. 2. Otherwise we change the current list to the type requested here. This piece of code changes the list style at the current point to the Style requested by the user.

This code stops the list at the current point.

Start new list. 4 Possibilities. 1. If there is a list at the current point and the user choose no list, stop the list the current point.

2. start a new list with the properties given if there is not a list at the current point.

3. Start a sublist at the current point if a list already exists there and contains two or more items.

4. Change the list to the requested value if a list already eists but only has one item in it.

OK Attach the block at this point to the previous list of the same margin.

References UT_GenericVector< T >::addItem(), AV_CHG_HDRFTR, AV_CHG_MOTION, PD_Document::beginUserAtomicGlob(), FV_View::changeListStyle(), UT_GenericVector< T >::clear(), clearDirty(), FV_View::cmdUnselectSelection(), DIM_IN, PD_Document::disableListUpdates(), PD_Document::enableListUpdates(), PD_Document::endUserAtomicGlob(), FV_View::ensureInsertionPointOnScreen(), gchar, getAutoNum(), fl_Layout::getAutoNum(), getBlock(), FV_View::getBlocksInSelection(), getCurrentFold(), fl_Layout::getDocument(), FV_View::getDocument(), UT_GenericVector< T >::getItemCount(), fl_BlockLayout::getLevel(), fl_BlockLayout::getListStyleString(), UT_GenericVector< T >::getNthItem(), FV_View::getPoint(), fl_ContainerLayout::getPrev(), fl_BlockLayout::getPreviousListOfSameMargin(), FV_View::getSelectionAnchor(), fl_Layout::getStruxDocHandle(), PD_Document::getStruxPosition(), PD_Document::getUID(), AP_Dialog_Modeless::getView(), fl_BlockLayout::isListItem(), isModal(), isPageLists(), UT_UniqueId::List, LIST_DEFAULT_INDENT, m_Answer, m_bApplyToCurrent, m_bFoldingLevelChanged, m_bResumeList, m_bStartNewList, m_fAlign, m_fIndent, m_isListAtPoint, m_iStartValue, m_NewListType, m_OutProps, m_Output, m_pszDecimal, m_pszDelim, m_pszFont, NOT_A_LIST, FV_View::notifyListeners(), fl_BlockLayout::resumeList(), FV_View::setCollapsedRange(), FV_View::setPoint(), fl_BlockLayout::StartList(), PD_Document::StopList(), PD_Document::updateDirtyLists(), FV_View::updateLayout(), FV_View::updateScreen(), UT_convertInchesToDimensionString(), and UT_std_string_sprintf().

Referenced by AP_Win32Dialog_Lists::_onApply(), AP_UnixDialog_Lists::applyClicked(), and AP_CocoaDialog_Lists::applyClicked.

void AP_Dialog_Lists::clearDirty ( void ) [inline]

Referenced by AP_Win32Dialog_Lists::_onApply(), AP_Win32Dialog_Lists::_onInitDialog(), AP_Win32Dialog_Lists::activate(), Apply(), AP_Win32Dialog_Lists::autoupdateLists(), AP_Win32Dialog_Lists::runModal(), AP_UnixDialog_Lists::runModal(), AP_CocoaDialog_Lists::runModal, AP_Win32Dialog_Lists::runModeless(), AP_UnixDialog_Lists::runModeless(), and AP_CocoaDialog_Lists::runModeless.

void AP_Dialog_Lists::copyCharToDecimal ( const std::string & pszDecimal ) [inline, protected]

Referenced by AP_UnixDialog_Lists::_gatherData(), AP_CocoaDialog_Lists::_gatherData, and AP_Win32Dialog_Lists::_getDisplayedData().

void AP_Dialog_Lists::copyCharToDelim ( const std::string & pszDelim ) [inline, protected]

Referenced by AP_UnixDialog_Lists::_gatherData(), AP_CocoaDialog_Lists::_gatherData, and AP_Win32Dialog_Lists::_getDisplayedData().

void AP_Dialog_Lists::copyCharToFont ( const std::string & pszFont ) [inline, protected]

Referenced by AP_UnixDialog_Lists::_gatherData(), AP_CocoaDialog_Lists::_gatherData, and AP_Win32Dialog_Lists::_selectFont().

void AP_Dialog_Lists::copyCharToWindowName ( const char * pszName ) [protected]

References AP_Dialog_Modeless::m_WindowName.

UT_uint32 AP_Dialog_Lists::decodeListType ( char * listformat )

void AP_Dialog_Lists::event_PreviewAreaExposed ( void ) [virtual]

Actually draw the preview.

References AP_Lists_preview::draw(), fillFakeLabels(), m_pListsPreview, and UT_ASSERT_HARMLESS.

Referenced by AP_Win32Dialog_Lists::_previewExposed(), AP_UnixDialog_Lists::previewExposed(), and AP_CocoaDialog_Lists::previewExposed.

void AP_Dialog_Lists::fillDialogFromBlock ( void )

This method reads all the List info from the document at the curent point and loads it into the dialog member variables.

References findVecItem(), gchar, fl_ContainerLayout::getAP(), getAutoNum(), getBlock(), fl_BlockLayout::getListAttributesVector(), fl_BlockLayout::getListPropertyVector(), fl_BlockLayout::getListTypeFromStyle(), PP_AttrProp::getProperty(), LIST_DEFAULT_INDENT, LIST_DEFAULT_INDENT_LABEL, m_DocListType, m_fAlign, m_fIndent, m_iCurrentLevel, m_iID, m_iLevel, m_iStartValue, m_previousListExistsAtPoint, m_pszDecimal, m_pszDelim, m_pszFont, setFoldLevelInGUI(), and UT_convertToInches().

Referenced by PopulateDialogData().

void AP_Dialog_Lists::fillDialogFromVector ( UT_GenericVector< const gchar * > * vp )

The vector vp contains all the properties we need to fill our dialog variables. Fill our variables from this vector. This is used by the Modal dialog and is filled from the styles dialog.

References findVecItem(), getBlock(), UT_GenericVector< T >::getItemCount(), fl_BlockLayout::getListTypeFromStyle(), UT_GenericVector< T >::getNthItem(), LIST_DEFAULT_INDENT, LIST_DEFAULT_INDENT_LABEL, m_DocListType, m_fAlign, m_fIndent, m_iStartValue, m_NewListType, m_pszDecimal, m_pszDelim, m_pszFont, and UT_convertToInches().

Referenced by AP_Dialog_Styles::ModifyLists().

void AP_Dialog_Lists::fillFakeLabels ( void )

This method sets the parameters of the "Fake" list shown in the preview. The values display are theones the user should expect to get in their document should they press "Apply"

m_bisCustomized is true if the user has changed anything in the dialog without pressing "Apply". If this variable is false we should just display what is in the document at the list point.

This method loads the list info from the document at the current point into the XP member variables.

OK fill the preview variables with what they need and load them into the preview class.

References getBlock(), fl_BlockLayout::getLevel(), isModal(), m_bguiChanged, m_bisCustomized, m_DocListType, m_fAlign, m_fIndent, m_iLevel, m_iStartValue, m_NewListType, m_pFakeAuto, m_pListsPreview, m_pszDecimal, m_pszDelim, m_pszFont, NOT_A_LIST, PopulateDialogData(), and AP_Lists_preview::setData().

Referenced by event_PreviewAreaExposed().

void AP_Dialog_Lists::fillUncustomizedValues ( void )

This function loads the standard values into Delim, decimal, format m_fAlign, m_iLevel and m_iStarValue based on m_NewListType

m_fAlign and m_fIndent should be in inches

References ARABICNUMBERED_LIST, BULLETED_LIST, AP_Dialog_Modeless::getView(), HEBREW_LIST, LIST_DEFAULT_INDENT, LIST_DEFAULT_INDENT_LABEL, LOWERCASE_LIST, m_fAlign, m_fIndent, m_iLevel, m_iStartValue, m_NewListType, m_pszDecimal, m_pszDelim, m_pszFont, NOT_A_LIST, NUMBERED_LIST, PP_getAttribute(), and UPPERCASE_LIST.

Referenced by AP_Win32Dialog_Lists::_resetCustomValues(), AP_Win32Dialog_Lists::_typeChanged(), AP_UnixDialog_Lists::customChanged(), AP_CocoaDialog_Lists::customChanged, PopulateDialogData(), s_styleChanged(), s_typeChanged(), AP_UnixDialog_Lists::styleChanged(), AP_CocoaDialog_ListsController::styleChangedAction:, and AP_CocoaDialog_Lists::typeChanged.

UT_sint32 AP_Dialog_Lists::findVecItem	(	const PP_PropertyVector &	v,
		const char *	key
	)			`[static]`

XXX this should be moved out of here.

References ASSERT_PV_SIZE.

UT_sint32 AP_Dialog_Lists::findVecItem	(	UT_GenericVector< const gchar * > *	v,
		const char *	key
	)

This method returns the index to the value corresponding to the key in this props vector

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

Referenced by fillDialogFromBlock(), and fillDialogFromVector().

void AP_Dialog_Lists::generateFakeLabels ( void )

This routine generates it's own AutoNum's and Layout pointers for use in the preview

References DELETEP, m_iID, m_NewListType, m_newStartValue, m_pFakeAuto, m_pFakeDoc, m_pFakeLayout, m_pFakeSdh, m_pszDecimal, m_pszDelim, fl_Layout::setAutoNum(), and UNREFP.

Referenced by _createPreviewFromGC().

AP_Dialog_Lists::tAnswer AP_Dialog_Lists::getAnswer ( void ) const

Reimplemented from AP_Dialog_Modeless.

References m_Answer.

Referenced by AP_Dialog_Styles::ModifyLists(), and AP_UnixDialog_Lists::runModal().

fl_AutoNumPtr AP_Dialog_Lists::getAutoNum ( void ) const

References fl_Layout::getAutoNum(), and getBlock().

Referenced by Apply(), fillDialogFromBlock(), getID(), isLastOnLevel(), and PopulateDialogData().

AV_View * AP_Dialog_Lists::getAvView ( void )

References XAP_Dialog_Modeless::getActiveFrame(), and XAP_Frame::getCurrentView().

Referenced by AP_Win32Dialog_Lists::autoupdateLists(), AP_UnixDialog_Lists::autoupdateLists(), AP_CocoaDialog_Lists::autoupdateLists, s_update(), and AP_CocoaDialog_ListsController::windowDidBecomeKey:.

fl_BlockLayout * AP_Dialog_Lists::getBlock ( void ) const

Returns the block at the current point.

References FV_View::getCurrentBlock(), and AP_Dialog_Modeless::getView().

Referenced by _createPreviewFromGC(), AP_UnixDialog_Lists::_gatherData(), AP_CocoaDialog_Lists::_gatherData, Apply(), AP_Lists_preview::draw(), fillDialogFromBlock(), fillDialogFromVector(), fillFakeLabels(), getAutoNum(), getID(), isLastOnLevel(), PopulateDialogData(), StartList(), and StopList().

UT_sint32 AP_Dialog_Lists::getCurrentFold ( void ) [inline, protected]

Referenced by Apply(), AP_Win32Dialog_Lists::setFoldLevelInGUI(), AP_UnixDialog_Lists::setFoldLevelInGUI(), and AP_CocoaDialog_Lists::setFoldLevelInGUI.

const std::string& AP_Dialog_Lists::getDecimal ( void ) const [inline, protected]

Referenced by AP_Win32Dialog_Lists::_setDisplayedData(), AP_UnixDialog_Lists::loadXPDataIntoLocal(), and AP_CocoaDialog_Lists::loadXPDataIntoLocal.

const std::string& AP_Dialog_Lists::getDelim ( void ) const [inline, protected]

Referenced by AP_Win32Dialog_Lists::_setDisplayedData(), AP_UnixDialog_Lists::loadXPDataIntoLocal(), and AP_CocoaDialog_Lists::loadXPDataIntoLocal.

const std::string& AP_Dialog_Lists::getFont ( void ) [inline, protected]

Referenced by AP_UnixDialog_Lists::loadXPDataIntoLocal(), and AP_CocoaDialog_Lists::loadXPDataIntoLocal.

UT_uint32 AP_Dialog_Lists::getID ( void )

References getAutoNum(), and getBlock().

UT_UCSChar * AP_Dialog_Lists::getListLabel ( UT_sint32 itemNo )

Little convienence method to get the List label from the FakeAutoNum used in the Preview.

References m_pFakeAuto, m_pFakeSdh, UT_ASSERT_HARMLESS, UT_MIN, and UT_UCS4_strlen().

Referenced by AP_Lists_preview::draw().

AP_Lists_preview* AP_Dialog_Lists::getListsPreview ( ) [inline, protected]

Referenced by AP_Win32Dialog_Lists::_onInitDialog().

gchar* AP_Dialog_Lists::getListStyleString ( UT_uint32 iListType )

const UT_Vector* AP_Dialog_Lists::getOutProps ( void ) const [inline]

Referenced by AP_Dialog_Styles::ModifyLists().

UT_uint32 AP_Dialog_Lists::getStoredID ( void ) [inline]

UT_uint32 AP_Dialog_Lists::getTick ( void )

This is the local cache of the change number reported in the AV_View. Only do an auto update if this number is different from the AV_View.

References m_iLocalTick.

Referenced by AP_Win32Dialog_Lists::autoupdateLists(), AP_UnixDialog_Lists::autoupdateLists(), AP_CocoaDialog_Lists::autoupdateLists, s_update(), and AP_CocoaDialog_ListsController::windowDidBecomeKey:.

const char * AP_Dialog_Lists::getWindowName ( void ) const [protected]

References AP_Dialog_Modeless::m_WindowName.

Referenced by AP_UnixDialog_Lists::_constructWindow(), AP_Win32Dialog_Lists::_updateCaption(), AP_UnixDialog_Lists::activate(), AP_CocoaDialog_Lists::activate, AP_UnixDialog_Lists::notifyActiveFrame(), and AP_CocoaDialog_Lists::notifyActiveFrame.

XAP_String_Id AP_Dialog_Lists::getWindowTitleStringId ( ) [protected, virtual]

Implements AP_Dialog_Modeless.

bool AP_Dialog_Lists::isDirty ( void ) const [inline]

Referenced by AP_Win32Dialog_Lists::_enableControls(), AP_Win32Dialog_Lists::_onDeltaPos(), AP_Win32Dialog_Lists::autoupdateLists(), AP_UnixDialog_Lists::autoupdateLists(), AP_CocoaDialog_Lists::autoupdateLists, s_update(), AP_UnixDialog_Lists::updateDialog(), AP_CocoaDialog_Lists::updateDialog, and AP_CocoaDialog_ListsController::windowDidBecomeKey:.

bool AP_Dialog_Lists::isLastOnLevel ( void )

References getAutoNum(), and getBlock().

bool AP_Dialog_Lists::isModal ( void ) const [inline]

Referenced by AP_UnixDialog_Lists::_constructWindow(), AP_UnixDialog_Lists::_constructWindowContents(), AP_Win32Dialog_Lists::_onApply(), AP_Win32Dialog_Lists::_onInitDialog(), AP_Win32Dialog_Lists::activate(), Apply(), AP_UnixDialog_Lists::applyClicked(), AP_CocoaDialog_Lists::applyClicked, AP_Win32Dialog_Lists::destroy(), AP_UnixDialog_Lists::destroy(), AP_CocoaDialog_Lists::destroy, fillFakeLabels(), AP_Win32Dialog_Lists::isPageLists(), AP_UnixDialog_Lists::isPageLists(), AP_CocoaDialog_Lists::isPageLists, and AP_CocoaDialog_ListsController::windowDidLoad.

virtual bool AP_Dialog_Lists::isPageLists ( void ) [protected, pure virtual]

Implemented in AP_CocoaDialog_Lists, and AP_UnixDialog_Lists.

Referenced by Apply().

void AP_Dialog_Lists::PopulateDialogData ( void )

This method looks to see if there is a list at the current point. If so fill the dialog with that stuff, otherwise fill the dialog with the uncustomized values corresponding to m_NewListType.

References fillDialogFromBlock(), fillUncustomizedValues(), getAutoNum(), getBlock(), fl_BlockLayout::getLevel(), fl_BlockLayout::getListLabel(), fl_BlockLayout::isListItem(), m_curListLabel, m_curListLevel, m_curStartValue, m_DocListType, m_isListAtPoint, m_iStartValue, UT_MIN, and UT_UCS4_strlen().