QCAD
Open Source 2D CAD
RFileImporterRegistry Class Reference

Registry of all available file importers (RFileImporter). More...

#include <RFileImporterRegistry.h>

Static Public Member Functions

static RFileImportergetFileImporter (const QString &fileName, const QString &nameFilter, RDocument &document, RMessageHandler *messageHandler=NULL, RProgressHandler *progressHandler=NULL)
 
static QStringList getFilterExtensionPatterns ()
 
static QStringList getFilterExtensions ()
 
static QStringList getFilterStrings ()
 
static bool hasFileImporter (const QString &fileName, const QString &nameFilter)
 
static void registerFileImporter (RFileImporterFactory *factory)
 Registers a file importer. More...
 
static void unregisterFileImporter (RFileImporterFactory *factory)
 Unregisters a file importer. More...
 

Static Private Attributes

static QList< RFileImporterFactory * > factories
 Copyright (c) 2011-2018 by Andrew Mustun. More...
 

Detailed Description

Registry of all available file importers (RFileImporter).

File importers must register themselves in this registry to become available to the user of the application.

Scriptable:\nThis class is available in script environments.\n

Member Function Documentation

◆ getFileImporter()

RFileImporter * RFileImporterRegistry::getFileImporter ( const QString &  fileName,
const QString &  nameFilter,
RDocument document,
RMessageHandler messageHandler = NULL,
RProgressHandler progressHandler = NULL 
)
static
Returns
A new instance of the first file importer found that can handle the given file or NULL if no suitable importer can be found.

◆ getFilterExtensionPatterns()

QStringList RFileImporterRegistry::getFilterExtensionPatterns ( )
static
Returns
List of all importable file extension patterns (e.g. '*.dxf', '*.dwg', ...).

◆ getFilterExtensions()

QStringList RFileImporterRegistry::getFilterExtensions ( )
static
Returns
List of all importable file extensions (e.g. 'dxf', 'dwg', ...).

◆ getFilterStrings()

QStringList RFileImporterRegistry::getFilterStrings ( )
static

◆ hasFileImporter()

bool RFileImporterRegistry::hasFileImporter ( const QString &  fileName,
const QString &  nameFilter 
)
static
Returns
True if an importer is available that can import the given file.

◆ registerFileImporter()

void RFileImporterRegistry::registerFileImporter ( RFileImporterFactory factory)
static

Registers a file importer.

Parameters
factoryFunctionThe function that can be used to instantiate the importer.
checkFunctionThe function that can be used to check whether the importer can import a given file.

◆ unregisterFileImporter()

void RFileImporterRegistry::unregisterFileImporter ( RFileImporterFactory factory)
static

Unregisters a file importer.

Parameters
factoryFunctionThe function that can be used to instantiate the importer.
checkFunctionThe function that can be used to check whether the importer can import a given file.

Member Data Documentation

◆ factories

QList< RFileImporterFactory * > RFileImporterRegistry::factories
staticprivate

Copyright (c) 2011-2018 by Andrew Mustun.

All rights reserved.

This file is part of the QCAD project.

QCAD is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

QCAD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with QCAD.


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