Search Toolkit Book for IFileFormatLoaderManager

#include <gui/core/ui_file_load_manager.hpp>

Inheritance diagram for IFileFormatLoaderManager:

Collaboration diagram for IFileFormatLoaderManager:

Public Member Functions
virtual string	GetFileLoaderId () const =0

virtual wxString	GetFormatWildcard ()=0
	return file wildcard for the format (example - ".txt;.tab" ) More...

virtual bool	ValidateFilenames (const vector< wxString > &filenames)=0
	checks given filenames and returns true if the manager can handle them, otherwise - shows an error message More...

virtual void	SetFilenames (const vector< wxString > &filenames)=0
	initilize the manager with the given filenames More...

virtual void	GetFilenames (vector< wxString > &filenames) const =0
	get actual filenames that will be opened More...

virtual bool	IsInitialState ()=0
	return true if the current state of the loader UI is the first valid state (first step in a wizard-like sequence) More...

virtual bool	RecognizeFormat (const wxString &filename)=0
	return true if the given file format is supported by this manager More...

virtual bool	RecognizeFormat (CFormatGuess::EFormat fmt)=0
	return true if the given file format is supported by this manager More...

virtual bool	SingleFileLoader () const
	returns true if loader can handle only one file More...

virtual bool	CanGuessFormat () const
	returns true if loader's format can be guessed More...

Public Member Functions inherited from IUIToolManager
virtual const IUIObject &	GetDescriptor () const =0
	Returns the object describing this tool (UI meta data). More...

virtual void	SetServiceLocator (IServiceLocator *srv_locator)=0
	Sets / unsets Service Locator. More...

virtual void	SetParentWindow (wxWindow *parent)=0

virtual void	InitUI ()=0
	Initializes the Manager before using it in UI. More...

virtual void	CleanUI ()=0
	CleanUI() is called after the host finished using the manager. More...

virtual wxPanel *	GetCurrentPanel ()=0
	Return the panel corresponding to the current state of Tool Manager. More...

virtual wxPanel *	GetMaxPanel ()
	Return the panel that occupies max size on display, to calculate dialog window size. More...

virtual bool	IsFinalState ()=0
	True if Tool Manager has reached its final state, i.e. More...

virtual bool	IsCompletedState ()=0
	Manager goes into "Complete" state when "Finish" button is pressed and all input data is gatherred and validated. More...

virtual bool	CanDo (EAction action)=0
	Indicates whether given transition is possible in the current state. More...

virtual bool	DoTransition (EAction action)=0
	Performs transition if possible and returns true, otherwise the function shall warn the user about the problem preventing the transition (such as insufficient or invalid input) and return false. More...

virtual IUIToolManager *	GetAlternateToolManager ()
	If a transition fails, it may make sense to switch to a different tool manger When a tool manager identifies a more appropriate manager for a task, it returns it here, otherwise NULL. More...

virtual IAppTask *	GetTask ()=0
	Once parameters are gathered and validated this function is called to produce the final Task object that will be executed to do the actual computational work. More...

virtual IExecuteUnit *	GetExecuteUnit ()

virtual IWizardPage *	GetFirstPage ()
	Returns first options page (if any) of the tool to be shown in wizard dialog. More...

virtual IWizardPage *	GetOptionsPage ()
	Returns page for tool options (long wizard path via "Options" button) More...

virtual void	SetPrevPage (IWizardPage *)
	Sets a wizard page which should show before the first page of the tool. More...

virtual void	SetNextPage (IWizardPage *)
	Sets a wizard page which should show after the last page of the tool. More...

virtual void	RestoreDefaults ()
	Restores the default options for the current panel. More...

virtual void	ResetState ()

virtual bool	UsesSingleOMScope ()

virtual	~IUIToolManager ()

Additional Inherited Members
Public Types inherited from IUIToolManager
enum	EAction { eBack = 0 , eNext , eSkip }

Detailed Description

IFileFormatLoaderManager.

IFileFormatLoaderManager extends IUIToolManager interface. The interface represents a specialized Loader Manager that loads files in a particular format.

Definition at line 67 of file ui_file_load_manager.hpp.