KLFAddOnInfo Class Reference

#include <klfmain.h>

Classes
struct	PluginSysInfo

Public Member Functions
	KLFAddOnInfo (QString rccfpath, bool isFresh=false)
	KLFAddOnInfo (const KLFAddOnInfo &o)
	~KLFAddOnInfo ()
QString	dir ()
QString	fname ()
QString	fpath ()
bool	islocal ()
QString	title ()
QString	author ()
QString	description ()
QString	klfminversion ()
QString	rccmountroot ()
	where in the resource tree this rcc resource data is mounted
QStringList	pluginList () const
PluginSysInfo	pluginSysInfo (const QString &plugin) const
QString	pluginLocalSubDirName (const QString &plugin) const
QStringList	localPluginList () const
QStringList	translations ()
bool	isfresh ()

Detailed Description

Definition at line 55 of file klfmain.h.

Constructor & Destructor Documentation

KLFAddOnInfo::KLFAddOnInfo	(	QString	rccfpath,
		bool	isFresh = false
	)

Reads RCC file rccfpath and parses its rccinfo/info.xml, etc. sets all fields to correct values and isfresh to isFresh .

Definition at line 59 of file klfmain.cpp.

References QFileInfo::absoluteFilePath(), QFileInfo::absolutePath(), QString::arg(), QDomDocument::documentElement(), QDir::entryList(), QFileInfo::fileName(), QDomNode::isNull(), QFileInfo::isWritable(), KLF_ASSERT_CONDITION, klfDbg, QDomNode::nextSibling(), QDomNode::nodeType(), QFile::open(), QResource::registerResource(), QString::section(), QDomDocument::setContent(), QDomElement::text(), QDomNode::toElement(), and QObject::tr().

KLFAddOnInfo::KLFAddOnInfo

(

const KLFAddOnInfo &

o

)

Create a copy of the add-on info structure other

Definition at line 282 of file klfmain.cpp.

KLFAddOnInfo::~KLFAddOnInfo

(

)

Definition at line 289 of file klfmain.cpp.

References QResource::unregisterResource().

Member Function Documentation

QString KLFAddOnInfo::author ( )

inline

the info in the add-on's info.xml file

Definition at line 96 of file klfmain.h.

QString KLFAddOnInfo::description ( )

inline

the info in the add-on's info.xml file

Definition at line 98 of file klfmain.h.

QString KLFAddOnInfo::dir ( )

inline

Directory in which the RCC file resides

Definition at line 85 of file klfmain.h.

QString KLFAddOnInfo::fname ( )

inline

Name of the RCC file (no path)

Definition at line 87 of file klfmain.h.

QString KLFAddOnInfo::fpath ( )

inline

in principle: absdir(dir()) + "/" + fname()

Definition at line 89 of file klfmain.h.

Referenced by KLFI18nFile::KLFI18nFile(), and main_load_extra_resources().

bool KLFAddOnInfo::isfresh ( )

inline

Fresh file: add-on imported during this execution; ie. KLatexFormula needs to be restarted for this add-on to take effect. The constructor sets this value to FALSE, set it manually to TRUE if needed (e.g. in KLFSettings).

Definition at line 140 of file klfmain.h.

bool KLFAddOnInfo::islocal ( )

inline

local file: can be removed (e.g. not in a global path /usr/share/... )

Definition at line 91 of file klfmain.h.

QString KLFAddOnInfo::klfminversion ( )

inline

the info in the add-on's info.xml file

Definition at line 100 of file klfmain.h.

Referenced by KLFSettings::importAddOn().

QStringList KLFAddOnInfo::localPluginList

(

)

const

A list of locally (ie. in ~/.klatexformula/plugins/) installed plugins coming from this add-on.

The path is relative to ~/.klatexformula/plugins/.

Note

Only plugins for the current os/architecture is returned.

Definition at line 271 of file klfmain.cpp.

References QDir::cleanPath(), QFileInfo::fileName(), and pluginLocalSubDirName().

QStringList KLFAddOnInfo::pluginList ( ) const

inline

The list of plugins provided by this add-on (list of files ":/plugins/[<dir>/]<plugin-name>*.so|dll").

This list stores full file names relative to plugin dir in add-on (e.g. "libskin.so" or "linux-x86-klf3.1.1/libskin.so") .

See also localPluginList().

Definition at line 113 of file klfmain.h.

QString KLFAddOnInfo::pluginLocalSubDirName ( const QString &  plugin ) const

inline

Definition at line 117 of file klfmain.h.

References QString::arg().

Referenced by localPluginList().

PluginSysInfo KLFAddOnInfo::pluginSysInfo ( const QString &  plugin ) const

inline

Definition at line 115 of file klfmain.h.

QString KLFAddOnInfo::rccmountroot ( )

inline

where in the resource tree this rcc resource data is mounted

Definition at line 103 of file klfmain.h.

Referenced by KLFSettings::importAddOn().

QString KLFAddOnInfo::title ( )

inline

the info in the add-on's info.xml file

Definition at line 94 of file klfmain.h.

QStringList KLFAddOnInfo::translations ( )

inline

The list of translation files provided by this add-on (list of files :/i18n/*.qm) This list stores full file names without the path (e.g. "klf_fr.qm")

Definition at line 135 of file klfmain.h.

Referenced by KLFSettings::importAddOn(), and klf_reload_translations().

---

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

• src/klfmain.h
• src/klfmain.cpp