NotSavedPrompter Class Reference

Inheritance diagram for NotSavedPrompter:

Public Member Functions
	NotSavedPrompter ()
	~NotSavedPrompter ()
void	addObject (const char *str, const CallBack &savecb, bool issaveas, const void *dataptr)
void	addObject (const uiString &str, const CallBack &savecb, bool issaveas, const void *dataptr)
bool	doTrigger (uiParent *, bool withcancel, const uiString &actiontype)
	Invoke the system. Returns false if cancel has been pressed. More...
const void *	getCurrentObjectData () const
uiParent *	getParent ()
bool	isSaveAs () const
int	queueID () const
void	reportSuccessfullSave ()
Public Member Functions inherited from CallBacker
	CallBacker ()
	CallBacker (const CallBacker &)
virtual	~CallBacker ()
bool	attachCB (const NotifierAccess &, const CallBack &, bool onlyifnew=false) const
bool	attachCB (const NotifierAccess *notif, const CallBack &cb, bool onlyifnew=false) const
void	detachAllNotifiers () const
	Call from the destructor of your inherited object. More...
void	detachCB (const NotifierAccess &, const CallBack &) const
void	detachCB (const NotifierAccess *notif, const CallBack &cb) const
virtual bool	isCapsule () const
bool	isNotifierAttached (const NotifierAccess *) const
	Only for debugging purposes, don't use. More...
void	stopReceivingNotifications () const

Static Public Member Functions
static NotSavedPrompter &	NSP ()
Static Public Member Functions inherited from CallBacker
static void	createReceiverForCurrentThread ()
static void	removeReceiverForCurrentThread ()

Public Attributes
Notifier< NotSavedPrompter >	promptSaving

Protected Member Functions
void	closeQueueCB (CallBacker *cb)

Protected Attributes
uiNotSavedDlg *	dlg_
ObjectSet< NotSavedPrompterData >	objects_
int	queueid_

Friends
class	uiNotSavedDlg

Detailed Description

Presents a list of items that have not been saved, giving the user the opportunity to save them.

MyClass::MyClass()
{
    NotSavedPrompter::NSP().promptSaving.notify(
        mCB(this,MyClass,askSaveCB) );
}
 
MyClass::~MyClass()
{
    NotSavedPrompter::NSP().promptSaving.remove(
        mCB(this,MyClass,askSaveCB) );
}
 
void MyClass::askSaveCB( CallBacker* )
{
    if ( not_saved )
    {
        BufferString str("Object type \"" );
        str += name(); str += "\"";
 
        PtrMan<IOObj> ioobj = IOM().get( mid );
        const bool issaveas = (bool) ioobj;
 
        NotSavedPrompter::NSP().addObject( new NotSavedPrompter::Data(
            str.buf(), mCB(this,MyClass,saveCB()), issaveas, 0 ) );
    }
}
 
 
void MyClass::saveCB( CallBacker* )
{
    if ( NotSavedPrompter::NSP().isSaveAs() )
    {
        uiParent* uip = NotSavedPrompter::NSP().getParent();
        //Start dlg with uiparent and get new name
    }
 
    if ( successfulSave )
        NotSavedPrompter::NSP().reportSuccessfullSave()
}

<>

Constructor & Destructor Documentation

NotSavedPrompter()

NotSavedPrompter::NotSavedPrompter

(

)

~NotSavedPrompter()

NotSavedPrompter::~NotSavedPrompter ( )

inline

Member Function Documentation

addObject() [1/2]

void NotSavedPrompter::addObject	(	const char *	str,
		const CallBack &	savecb,
		bool	issaveas,
		const void *	dataptr
	)

Lets the object know that you have an object that should be added to the list of unsaved objects. Normally called when triggered by promptSaving.

Parameters

str	Description of the object (e.g. "Horizon A")
savecb	Callback that will save the object
issaveas	true if savecb will prompt user for a name
dataptr	Pointer that can be retrieved during savecb

addObject() [2/2]

void NotSavedPrompter::addObject	(	const uiString &	str,
		const CallBack &	savecb,
		bool	issaveas,
		const void *	dataptr
	)

Lets the object know that you have an object that should be added to the list of unsaved objects. Normally called when triggered by promptSaving.

Parameters

str	Description of the object (e.g. "Horizon A")
savecb	Callback that will save the object
issaveas	true if savecb will prompt user for a name
dataptr	Pointer that can be retrieved during savecb

closeQueueCB()

void NotSavedPrompter::closeQueueCB ( CallBacker *  cb )

protected

doTrigger()

bool NotSavedPrompter::doTrigger	(	uiParent *	,
		bool	withcancel,
		const uiString &	actiontype
	)

Invoke the system. Returns false if cancel has been pressed.

getCurrentObjectData()

const void* NotSavedPrompter::getCurrentObjectData

(

)

const

Returns

the dataptr of the currently active object.

Note

Only valid during a call from a cb given in addObject()

getParent()

uiParent* NotSavedPrompter::getParent

(

)

Returns

a pointer to the save-dialog, which can be used when creating a dialog in a callback given in addObject.

Note

Only valid during a call from a cb given in addObject()

isSaveAs()

bool NotSavedPrompter::isSaveAs

(

)

const

Returns

the issaveas status of the currently active object

Note

Only valid during a call from a cb given in addObject()

NSP()

static NotSavedPrompter& NotSavedPrompter::NSP ( )

static

queueID()

int NotSavedPrompter::queueID ( ) const

inline

When OK is pressed (i.e. not cancel), a queue is executed. If you want something to be executed, add it to this queue.

reportSuccessfullSave()

void NotSavedPrompter::reportSuccessfullSave

(

)

Let the dialog know that the current object was successfully saved.

Note

Only valid during a call from a cb given in addObject()

Friends And Related Function Documentation

uiNotSavedDlg

friend class uiNotSavedDlg

friend

Member Data Documentation

dlg_

uiNotSavedDlg* NotSavedPrompter::dlg_

protected

objects_

ObjectSet<NotSavedPrompterData> NotSavedPrompter::objects_

protected

promptSaving

Notifier<NotSavedPrompter> NotSavedPrompter::promptSaving

Will trigger from when users should save all unsaved objects, normally at survey change or shutdown.

queueid_

int NotSavedPrompter::queueid_

protected