IOFactory implementation for reading and writing QuickBooks data files. More...

Inheritance diagram for QuickbooksFactory:

Collaboration diagram for QuickbooksFactory:

Public Member Functions
	QuickbooksFactory ()
	Constructs the QuickBooks factory.
virtual bool	canRead (const FactoryParameters &file) override
	Checks whether the given file can be read by this factory.
virtual bool	canWrite (const FactoryParameters &file) override
	Checks whether the given file can be written by this factory.
virtual FactoryFeatures	factoryFeatures (const FactoryParameters &file, bool is_import) const
	Returns the feature flags supported by this factory for a given file.
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, bool is_read) override
	Populates the list of supported file formats.
virtual bool	readFile (FactoryParameters &file) override
	Reads a QuickBooks file and populates the design model.
virtual bool	writeFile (FactoryParameters &file) override
	Writes design data to a QuickBooks file.
Public Member Functions inherited from IOFactory
	IOFactory (const StringView &factory_name)
	Constructs an IOFactory with the given factory name.
virtual	~IOFactory ()
	Virtual destructor.
virtual bool	canRead (const File &file)
	Checks whether this factory can read the given file.
virtual bool	canRead (const FileFormat &file)
	Checks whether this factory can read the given file format.
virtual bool	canWrite (const File &file)
	Checks whether this factory can write the given file.
virtual bool	canWrite (const FileFormat &file)
	Checks whether this factory can write the given file format.
virtual FactoryOptions	defaultReadOptions (const FactoryParameters &file) const
	Returns the default read options for the given factory parameters.
virtual FactoryOptions	defaultWriteOptions (const FactoryParameters &file) const
	Returns the default write options for the given factory parameters.
virtual bool	determineExtension (const File &file, String &extension)
	Attempts to determine the file extension for the given file.
String	factoryReadAppFeature () const
	Returns the application feature string required for read operations.
String	factoryWriteAppFeature () const
	Returns the application feature string required for write operations.
virtual Buffer< UUID >	filterModelsToExport (Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const
	Filters a list of model UUIDs to only those that can be exported in the given format.
virtual String	getIcon (const File &file)
	Returns the icon name associated with the given file type.
void	getSupportedFormats (Buffer< FileFormat > &formats)
	Populates the given buffer with all supported file formats (both read and write).
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, const File &file)
	Populates the given buffer with formats supported for the specified file.
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models)
	Populates the given buffer with formats supported for writing the specified models.
virtual void	getSupportedFormatsByModelType (Buffer< FileFormat > &formats, bool is_read, const StringView &model_type)
	Populates the given buffer with formats matching a specific model type.
virtual void	getSupportedFormatsForExtension (Buffer< FileFormat > &formats, bool is_read, const StringView &extension)
	Populates the given buffer with formats matching a specific file extension.
virtual bool	isAutoEnabled () const
	Checks whether this factory is automatically enabled without requiring a password.
virtual bool	isFactoryEnabled (bool is_read) const
	Checks whether this factory is enabled for reading or writing.
const String &	name () const
	Returns the name of this factory.
Buffer< UUID >	readFileWithDefaultSettings (const File &file, DesignObjectLookup *lookup)
	Reads a file using default settings and returns the UUIDs of the created models.
Buffer< Scene >	readScenesFromFile (const File &file)
	Reads scenes from a file and returns them as a buffer of Scene objects.
void	throwIfNotEnabled (bool is_read)
	Throws an exception if the factory is not enabled for the given operation direction.
virtual bool	updateFromFile (const FactoryParameters &file, const FactoryOptions &old_options)
	Updates the factory parameters from a file, comparing against old options.
bool	writeScenesToFile (const File &file, const Buffer< Scene > &scene)
	Writes a buffer of scenes to a file.

Additional Inherited Members
Static Public Member Functions inherited from IOFactory
static void	EnableExtension (const StringView &extension, const StringView &read_password, const StringView &write_password)
	Enables a specific file extension with the given read and write passwords.
static void	EnableFactory (const StringView &factory, const StringView &read_password, const StringView &write_password)
	Enables a factory by name with the given read and write passwords.
static void	EnableFactory (IOFactory *factory, const StringView &read_password, const StringView &write_password)
	Registers an IOFactory instance with the system, enabling it for read and/or write.

Detailed Description

IOFactory implementation for reading and writing QuickBooks data files.

Supports import and export of customer, job, and invoice data in QuickBooks-compatible formats.

Definition at line 18 of file QuickbooksFactory.h.

Member Function Documentation

◆ canRead()

virtual bool QuickbooksFactory::canRead ( const FactoryParameters & file )

overridevirtual

Checks whether the given file can be read by this factory.

Parameters

[in] file The file parameters to check.

Returns: True if the file can be read.

Reimplemented from IOFactory.

◆ canWrite()

virtual bool QuickbooksFactory::canWrite ( const FactoryParameters & file )

overridevirtual

Checks whether the given file can be written by this factory.

Parameters

[in] file The file parameters to check.

Returns: True if the file can be written.

Reimplemented from IOFactory.

◆ factoryFeatures()

virtual FactoryFeatures QuickbooksFactory::factoryFeatures	(	const FactoryParameters &	file,
		bool	is_import ) const

virtual

Returns the feature flags supported by this factory for a given file.

Parameters

[in]	file	The file parameters to check.
[in]	is_import	Whether the operation is an import.

Returns: The supported factory features.

Implements IOFactory.

◆ getSupportedFormats()

virtual void QuickbooksFactory::getSupportedFormats	(	Buffer< FileFormat > &	formats,
		bool	is_read )

overridevirtual

Populates the list of supported file formats.

Parameters

[in]	formats	The buffer to add supported formats to.
[in]	is_read	Whether to list read formats (true) or write formats (false).

Implements IOFactory.

◆ readFile()

virtual bool QuickbooksFactory::readFile ( FactoryParameters & file )

overridevirtual

Reads a QuickBooks file and populates the design model.

Parameters

[in] file The file parameters including path and target model.

Returns: True if the file was read successfully.

Implements IOFactory.

◆ writeFile()

virtual bool QuickbooksFactory::writeFile ( FactoryParameters & file )

overridevirtual

Writes design data to a QuickBooks file.

Parameters

[in] file The file parameters including path and source model.

Returns: True if the file was written successfully.

Implements IOFactory.

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

FormSheetEditor/Headers/QuickbooksFactory.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canRead()

◆ canWrite()

◆ factoryFeatures()

◆ getSupportedFormats()

◆ readFile()

◆ writeFile()