Inheritance diagram for INotePaletteUtils:

Public Types
enum	{ kDefaultIID = IID_INOTEPALETTEUTILS }

Public Member Functions
virtual void	SetNoteToPalette (UIDRef docRef, UIDRef storyRef, UID noteDataUID, bool16 setSelection=kTrue, const RangeData *range=nil)=0

virtual void	TextLineInit (IControlView *writingView, UIDRef storyRef)=0

virtual void	ResetNotePalette (bool16 resetDocument, bool16 deactivatePalette, bool16 callingDuringResetView=kFalse)=0

virtual void	ClearOneButtonWidget (IPanelControlData *containerPanelData, WidgetID thisWidgetID)=0

virtual void	SetOneInfoWidget (IPanelControlData *containerPanelData, WidgetID thisWidget, const PMString &thisString)=0

virtual IControlView *	GetNoteWritingPad ()=0

virtual UIDRef	GetNotePaletteUIDRef ()=0

virtual UIDRef	GetNotePaletteStoryRef ()=0

virtual IControlView *	GetNotePanel ()=0

virtual bool16	IsNotePanelVisible ()=0

virtual bool16	ShowNotePanel (bool16 show=kTrue)=0

virtual bool16	InitializePaletteData ()=0

virtual bool16	DisplayedNoteActive ()=0

virtual void	UpdatePaletteButtons (bool16 collapsed)=0

virtual void	UpdateStoryLabel ()=0

virtual void	UpdateTotalNotesDisplay ()=0

virtual void	UpdatePaletteNoteModifyTime (UIDRef noteDataRef)=0

virtual void	InitPaletteWidgets (UIDRef storyRef, UIDRef docRef, UIDRef noteRef=UIDRef::gNull)=0

virtual void	SuspendDisplay ()=0

virtual void	ResumeDisplay ()=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual void INotePaletteUtils::ClearOneButtonWidget	(	IPanelControlData *	containerPanelData,
		WidgetID	thisWidgetID
	)

pure virtual

Resset a particular widget in the button section of the palette

virtual bool16 INotePaletteUtils::DisplayedNoteActive ( )

pure virtual

Return kTrue if the displayed note has an active selection. Return kFalse if the displayed note does not have an active selection.

virtual UIDRef INotePaletteUtils::GetNotePaletteStoryRef ( )

pure virtual

Return the story reference of the note being viewed in the note palette. If no note is viewed then it returns UIDRef::gNull.

virtual UIDRef INotePaletteUtils::GetNotePaletteUIDRef ( )

pure virtual

Return the note UID ref that is being viewed in the note palette If the note palette is not viewing any note data, it returns UIDRef::gNull.

virtual IControlView* INotePaletteUtils::GetNotePanel ( )

pure virtual

return the note palettepanel itself

virtual IControlView* INotePaletteUtils::GetNoteWritingPad ( )

pure virtual

get the writing view from the note palette, If the note palette is not opened, it returns nil. If the note palette is opened but its view is empty (not being used for viewing), it also returns nil. If the note palette is opened and its view data is valid, then it returns the view.

virtual bool16 INotePaletteUtils::InitializePaletteData ( )

pure virtual

Setup note information into palette widget and compose textlines

virtual void INotePaletteUtils::InitPaletteWidgets	(	UIDRef	storyRef,
		UIDRef	docRef,
		UIDRef	noteRef = `UIDRef::gNull`
	)

pure virtual

Initialize all the fields in the note palette with the given noteRef If no note is supplied, or storyRef is UIDRef::gNull, or noteRef is UIDRef::gNull, then reset note palette

virtual void INotePaletteUtils::ResetNotePalette	(	bool16	resetDocument,
		bool16	deactivatePalette,
		bool16	callingDuringResetView = `kFalse`
	)

pure virtual

Reset note palette, First clear all info widgets. Then to clear the writing panel with favor of reseting the story data or the document data, or both.

Parameters

resetDocument	reset view to current document
deactivatePalette	specifies an explicit deactivation of the note palette
this	is an internal undo/redo detail external users would pass kFalse (use default).

virtual void INotePaletteUtils::ResumeDisplay ( )

pure virtual

SetNoteToPalette() will resume display Note.

virtual void INotePaletteUtils::SetNoteToPalette	(	UIDRef	docRef,
		UIDRef	storyRef,
		UID	noteDataUID,
		bool16	setSelection = `kTrue`,
		const RangeData *	range = `nil`
	)

pure virtual

Display the given note to the note palette, content and other note information.

Parameters

setSelection	kTrue if resulting note is to receive active text focus.
range	to be used if valid, to set the selection in note palette

virtual void INotePaletteUtils::SetOneInfoWidget	(	IPanelControlData *	containerPanelData,
		WidgetID	thisWidget,
		const PMString &	thisString
	)

pure virtual

set a string to this widget only

virtual void INotePaletteUtils::SuspendDisplay ( )

pure virtual

SetNoteToPalette() will not display the note if SuspendDisplay is set

virtual void INotePaletteUtils::TextLineInit	(	IControlView *	writingView,
		UIDRef	storyRef
	)

pure virtual

Initialize the ITextLine structure for display of text in the writingView

virtual void INotePaletteUtils::UpdatePaletteButtons ( bool16 collapsed )

pure virtual

Update note palette buttons

virtual void INotePaletteUtils::UpdatePaletteNoteModifyTime ( UIDRef noteDataRef )

pure virtual

Update the modify time if noteDataRef == displayed note

virtual void INotePaletteUtils::UpdateStoryLabel ( )

pure virtual

Update the story label widget

virtual void INotePaletteUtils::UpdateTotalNotesDisplay ( )

pure virtual

Update the total notes widget

Public Types

Public Member Functions

Member Function Documentation