RabbitCommon::CDir Class Reference

Default directory: More...

#include <RabbitCommonDir.h>

Public Member Functions
QString	GetDirApplication ()
int	SetDirApplication (const QString &szPath)
QString	GetDirApplicationInstallRoot ()
int	SetDirApplicationInstallRoot (const QString &szPath)
QString	GetDirConfig (bool bReadOnly=false)
QString	GetDirLog ()
QString	GetDirData (bool bReadOnly=false)
	Get data directory.
QString	GetDirDocument (QString szProjectName=QString(), bool bReadOnly=false)
	GetDirDocument.
QString	GetDirDatabase (bool bReadOnly=false)
QString	GetDirDatabaseFile (const QString &szFile=QString(), bool bReadOnly=false)
QString	GetDirApplicationXml (bool bReadOnly=false)
QString	GetDirIcons (bool bReadOnly=false)
QString	GetDirTranslations (QString szPrefix=QString())
QString	GetDirPluginsTranslation (QString szDir="plugins")
QString	GetDirPlugins (const QString &szDir="")
QString	GetFileApplicationConfigure (bool bReadOnly=false)
QString	GetDirUserDocument ()
int	SetDirUserDocument (QString szPath)
QString	GetDirUserConfig ()
QString	GetDirUserData ()
QString	GetDirUserDatabase ()
QString	GetDirUserDatabaseFile (const QString &szFile=QString())
QString	GetDirUserXml ()
QString	GetDirUserImage ()
QString	GetFileUserConfigure ()

Static Public Member Functions
static CDir *	Instance ()
static int	CopyDirectory (const QString &fromDir, const QString &toDir, bool bCoverIfFileExists=true)

Private Attributes
QString	m_szDocumentPath
QString	m_szApplicationDir
QString	m_szApplicationRootDir

Detailed Description

Default directory:

ApplicationInstallRoot(The folder is only read) GetDirApplicationInstallRoot()
      |- bin                                    GetDirApplication()
      |- etc                                    GetDirConfig()
      |   |- xml                                GetDirApplicationXml()
      |   |- applicationName.conf               GetFileApplicationConfigure()
      |- log                                    GetDirLog()
      |- share                                  GetDirData()
      |   |- translations                       GetDirTranslations()
      |   |- doc                                GetDirDocument()
      |   |   |- ProjectName                    GetDirDocument(QCoreApplication::applicationName())
      |   |- icons                              GetDirIcons()
      |   |- db                                 GetDirDatabase()
      |       |- database.db                    GetDirDatabaseFile()
      |- plugins                                GetDirPlugins()
      |   |- translations                       GetDirPluginsTranslation()
      |   |- szDir                              GetDirPlugins("plugins/szDir")
      |       | - translations                  GetDirPluginsTranslation("plugins/szDir")
 
The follow folder is write and read:
DocumentRoot/Rabbit/applicationName             GetDirUserDocument()
      |- applicationName.conf                   GetFileUserConfigure()
      |- etc                                    GetDirUserConfig()
      |- share                                  GetDirUserData()
      |    |- image                             GetDirUserImage()
      |    |- db                                GetDirUserDatabase()
      |       |- database.db                    GetDirUserDatabaseFile()
      |    |- xml                               GetDirUserXml()
 
 
Android:
   assets (The folder is only read)             GetDirApplicationInstallRoot()
      |- etc                                    GetDirConfig()
      |   |- xml                                GetDirApplicationXml()
      |   |- applicationName.conf               GetFileApplicationConfigure()
      |- share                                  GetDirData()
      |   |- translations                       GetDirTranslations()
      |   |- icons                              GetDirIcons()
      |   |- db                                 GetDirDatabase()
      |       |- database.db                    GetDirDatabaseFile()
      |- plugins
      |   |- translations                       GetDirPluginsTranslation()
      |   |- szDir
      |       | - translations                  GetDirPluginsTranslation("plugins/szDir")
      
   DocumentRoot/Rabbit/applicationName          (Write and read)
      |- root
      |    |- etc                               GetDirConfig(true)
      |    |   |- xml                           GetDirApplicationXml(true)
      |    |   |- applicationName.conf          GetFileApplicationConfigure(true)
      |    |- log                               GetDirLog()
      |    |- share                             GetDirData(true)
      |    |   |- db                            GetDirDatabase(true)
      |        |- database.db                   GetDirDatabaseFile(true)

Note

In android, copy contents to DocumentRoot/Rabbit/applicationName from assets

See also

• GNU installation Directories in cmake
• GNU installation Directories

Definition at line 87 of file RabbitCommonDir.h.

Member Function Documentation

CopyDirectory()

int RabbitCommon::CDir::CopyDirectory ( const QString &  fromDir, const QString &  toDir, bool  bCoverIfFileExists = true  )

static

Definition at line 303 of file RabbitCommonDir.cpp.

GetDirApplication()

QString RabbitCommon::CDir::GetDirApplication

(

)

Definition at line 49 of file RabbitCommonDir.cpp.

GetDirApplicationInstallRoot()

QString RabbitCommon::CDir::GetDirApplicationInstallRoot

(

)

Definition at line 61 of file RabbitCommonDir.cpp.

GetDirApplicationXml()

QString RabbitCommon::CDir::GetDirApplicationXml

(

bool

bReadOnly = false

)

Definition at line 166 of file RabbitCommonDir.cpp.

GetDirConfig()

QString RabbitCommon::CDir::GetDirConfig

(

bool

bReadOnly = false

)

Definition at line 72 of file RabbitCommonDir.cpp.

GetDirData()

QString RabbitCommon::CDir::GetDirData

(

bool

bReadOnly = false

)

Get data directory.

Parameters

bReadOnly

Returns

data directory

Note

the data directory is ${CMAKE_INSTALL_DATADIR} in CMakeLists.txt

See also

• GNU installation Directories in cmake
• GNU installation Directories

Definition at line 118 of file RabbitCommonDir.cpp.

GetDirDatabase()

QString RabbitCommon::CDir::GetDirDatabase

(

bool

bReadOnly = false

)

Definition at line 150 of file RabbitCommonDir.cpp.

GetDirDatabaseFile()

QString RabbitCommon::CDir::GetDirDatabaseFile	(	const QString &	szFile = QString(),
		bool	bReadOnly = false
	)

Definition at line 159 of file RabbitCommonDir.cpp.

GetDirDocument()

QString RabbitCommon::CDir::GetDirDocument	(	QString	szProjectName = QString(),
		bool	bReadOnly = false
	)

GetDirDocument.

Parameters

szProjectName	project name
bReadOnly

Returns

the document directory

Note

the data directory is ${CMAKE_INSTALL_DOCDIR} in CMakeLists.txt

See also

• GNU installation Directories in cmake
• GNU installation Directories

Definition at line 142 of file RabbitCommonDir.cpp.

GetDirIcons()

QString RabbitCommon::CDir::GetDirIcons

(

bool

bReadOnly = false

)

Definition at line 273 of file RabbitCommonDir.cpp.

GetDirLog()

QString RabbitCommon::CDir::GetDirLog

(

)

Definition at line 97 of file RabbitCommonDir.cpp.

GetDirPlugins()

QString RabbitCommon::CDir::GetDirPlugins

(

const QString &

szDir = ""

)

Definition at line 175 of file RabbitCommonDir.cpp.

GetDirPluginsTranslation()

QString RabbitCommon::CDir::GetDirPluginsTranslation

(

QString

szDir = "plugins"

)

Definition at line 278 of file RabbitCommonDir.cpp.

GetDirTranslations()

QString RabbitCommon::CDir::GetDirTranslations

(

QString

szPrefix = QString()

)

See also

cmake/Translations.cmake

CTools::InstallTranslator

Definition at line 260 of file RabbitCommonDir.cpp.

GetDirUserConfig()

QString RabbitCommon::CDir::GetDirUserConfig

(

)

Definition at line 202 of file RabbitCommonDir.cpp.

GetDirUserData()

QString RabbitCommon::CDir::GetDirUserData

(

)

Definition at line 214 of file RabbitCommonDir.cpp.

GetDirUserDatabase()

QString RabbitCommon::CDir::GetDirUserDatabase

(

)

Definition at line 226 of file RabbitCommonDir.cpp.

GetDirUserDatabaseFile()

QString RabbitCommon::CDir::GetDirUserDatabaseFile

(

const QString &

szFile = QString()

)

Definition at line 235 of file RabbitCommonDir.cpp.

GetDirUserDocument()

QString RabbitCommon::CDir::GetDirUserDocument

(

)

Definition at line 188 of file RabbitCommonDir.cpp.

GetDirUserImage()

QString RabbitCommon::CDir::GetDirUserImage

(

)

Definition at line 251 of file RabbitCommonDir.cpp.

GetDirUserXml()

QString RabbitCommon::CDir::GetDirUserXml

(

)

Definition at line 242 of file RabbitCommonDir.cpp.

GetFileApplicationConfigure()

QString RabbitCommon::CDir::GetFileApplicationConfigure

(

bool

bReadOnly = false

)

Definition at line 290 of file RabbitCommonDir.cpp.

GetFileUserConfigure()

QString RabbitCommon::CDir::GetFileUserConfigure

(

)

Definition at line 296 of file RabbitCommonDir.cpp.

Instance()

CDir * RabbitCommon::CDir::Instance ( )

static

Definition at line 41 of file RabbitCommonDir.cpp.

SetDirApplication()

int RabbitCommon::CDir::SetDirApplication

(

const QString &

szPath

)

Definition at line 55 of file RabbitCommonDir.cpp.

SetDirApplicationInstallRoot()

int RabbitCommon::CDir::SetDirApplicationInstallRoot

(

const QString &

szPath

)

Definition at line 66 of file RabbitCommonDir.cpp.

SetDirUserDocument()

int RabbitCommon::CDir::SetDirUserDocument

(

QString

szPath

)

Definition at line 193 of file RabbitCommonDir.cpp.

Member Data Documentation

m_szApplicationDir

QString RabbitCommon::CDir::m_szApplicationDir

private

Definition at line 152 of file RabbitCommonDir.h.

m_szApplicationRootDir

QString RabbitCommon::CDir::m_szApplicationRootDir

private

Definition at line 153 of file RabbitCommonDir.h.

m_szDocumentPath

QString RabbitCommon::CDir::m_szDocumentPath

private

Definition at line 151 of file RabbitCommonDir.h.

---

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

• /home/runner/work/RabbitCommon/RabbitCommon/Src/RabbitCommonDir.h
• /home/runner/work/RabbitCommon/RabbitCommon/Src/RabbitCommonDir.cpp