Tools. More...

#include <RabbitCommonTools.h>

Public Types
enum class	TranslationType { Application , Library , Plugin }

Public Member Functions
void	Init (const QString szLanguage=QLocale::system().name())

void	Clean ()

int	SetLanguage (const QString szLanguage)

QString	GetLanguage ()

QSharedPointer< QTranslator >	InstallTranslator (const QString szName=QString(), TranslationType type=TranslationType::Application, const QString szPluginDir="plugins", const QString szLanguage=QLocale::system().name())
	Install translation.

int	RemoveTranslator (QSharedPointer< QTranslator > translator)

Static Public Member Functions
static CTools *	Instance ()

static QString	Version ()
	RabbitCommon version.

static QString	Information ()
	RabbitCommon information.

static bool	EnableCoreDump (bool bPrompt=true)
	Enable core dump.

static bool	executeByRoot (const QString &program, const QStringList &arguments=QStringList())
	executeByRoot: Run with administrator privileges

static int	InstallStartRun (const QString &szName=QString(), const QString &szPath=QString(), bool bAllUser=false)
	InstallStartRun: auto run when startup.

static int	RemoveStartRun (const QString &szName=QString(), bool bAllUser=false)

static bool	IsStartRun (const QString &szName=QString(), bool bAllUser=false)

static QString	GetCurrentUser ()

static QString	GetHostName ()

static int	GenerateDesktopFile (const QString &szPath=QString(), const QString &szName=QString())
	GenerateDesktopFile: Generate desktop file.

static int	AndroidRequestPermission (const QStringList &permissions)

static int	AndroidRequestPermission (const QString &permission)

Private Member Functions
void	InitResource ()

void	CleanResource ()

QSharedPointer< QTranslator >	InstallTranslatorFile (const QString szFile)

Private Attributes
QVector< QSharedPointer< QTranslator > >	m_Translator

QString	m_szLanguage

bool	m_Initialized

Detailed Description

Tools.

Definition at line 41 of file RabbitCommonTools.h.

Member Enumeration Documentation

◆ TranslationType

enum class RabbitCommon::CTools::TranslationType

strong

Definition at line 112 of file RabbitCommonTools.h.

Constructor & Destructor Documentation

◆ CTools()

static RabbitCommon Tools Translation RabbitCommon::CTools::CTools ( )

private

Definition at line 94 of file RabbitCommonTools.cpp.

◆ ~CTools()

RabbitCommon::CTools::~CTools ( )

privatevirtual

Definition at line 99 of file RabbitCommonTools.cpp.

Member Function Documentation

◆ AndroidRequestPermission() [1/2]

int RabbitCommon::CTools::AndroidRequestPermission ( const QString & permission )

static

Definition at line 223 of file RabbitCommonTools.cpp.

◆ AndroidRequestPermission() [2/2]

int RabbitCommon::CTools::AndroidRequestPermission ( const QStringList & permissions )

static

Definition at line 243 of file RabbitCommonTools.cpp.

◆ Clean()

void RabbitCommon::CTools::Clean ( )

Note: Free up the resource and call it only once before the program ends

Definition at line 304 of file RabbitCommonTools.cpp.

◆ CleanResource()

void RabbitCommon::CTools::CleanResource ( )

private

Definition at line 412 of file RabbitCommonTools.cpp.

◆ EnableCoreDump()

bool RabbitCommon::CTools::EnableCoreDump ( bool bPrompt = true )

static

Enable core dump.

Parameters

bPrompt prompt

Note: It must be called first in the main function

Definition at line 417 of file RabbitCommonTools.cpp.

◆ executeByRoot()

bool RabbitCommon::CTools::executeByRoot	(	const QString &	program,
		const QStringList &	arguments = `QStringList()`
	)

static

executeByRoot: Run with administrator privileges

Parameters

program
arguments

Definition at line 428 of file RabbitCommonTools.cpp.

◆ GenerateDesktopFile()

int RabbitCommon::CTools::GenerateDesktopFile	(	const QString &	szPath = `QString()`,
		const QString &	szName = `QString()`
	)

static

GenerateDesktopFile: Generate desktop file.

Parameters

szPath	the path of desktop file.
szName	the name of desktop file. Default: "org.Rabbit." + qApp->applicationName() + ".desktop"

Definition at line 526 of file RabbitCommonTools.cpp.

◆ GetCurrentUser()

QString RabbitCommon::CTools::GetCurrentUser ( )

static

Definition at line 560 of file RabbitCommonTools.cpp.

◆ GetHostName()

QString RabbitCommon::CTools::GetHostName ( )

static

Definition at line 577 of file RabbitCommonTools.cpp.

◆ GetLanguage()

QString RabbitCommon::CTools::GetLanguage ( )

Definition at line 121 of file RabbitCommonTools.cpp.

◆ Information()

QString RabbitCommon::CTools::Information ( )

static

RabbitCommon information.

Definition at line 147 of file RabbitCommonTools.cpp.

◆ Init()

void RabbitCommon::CTools::Init ( const QString szLanguage = QLocale::system().name() )

Note: Initialize the resource, which is called only once at the beginning of the program, usually after QApplication a(argc, argv) at the beginning of the main() function
int main(int argc, char* argv[]) {

QApplication a(argc, argv);

a.setApplicationName(......);

RabbitCommon::CTools::Instance->Init();

......

}

RabbitCommon::CTools::Init
void Init(const QString szLanguage=QLocale::system().name())
Definition RabbitCommonTools.cpp:251

If you put it before QApplication a(argc, argv), you need to call CDir::Instance()->SetDirApplication() and CDir::Instance()->SetDirApplicationInstallRoot()

int main(int argc, char* argv[]) {
    CDir::Instance()->SetDirApplication();
    CDir::Instance()->SetDirApplicationInstallRoot();
    RabbitCommon::CTools::Instance->Init();
    QApplication a(argc, argv);
    a.setApplicationName(......);
    ......
}

Definition at line 251 of file RabbitCommonTools.cpp.

◆ InitResource()

void RabbitCommon::CTools::InitResource ( )

private

Definition at line 407 of file RabbitCommonTools.cpp.

◆ InstallStartRun()

int RabbitCommon::CTools::InstallStartRun	(	const QString &	szName = `QString()`,
		const QString &	szPath = `QString()`,
		bool	bAllUser = `false`
	)

static

InstallStartRun: auto run when startup.

Parameters

szName	The programe name Windows: is programe name Linux: the name of desktop file.
szPath
bAllUser	true: all user false: current user

Definition at line 437 of file RabbitCommonTools.cpp.

◆ InstallTranslator()

QSharedPointer< QTranslator > RabbitCommon::CTools::InstallTranslator	(	const QString	szName = `QString()`,
		TranslationType	type = `TranslationType::Application`,
		const QString	szPluginDir = `"plugins"`,
		const QString	szLanguage = `QLocale::system().name()`
	)

Install translation.

Parameters

szName	translation name
szLanguage	language
type	TranslationType
szPluginDir	plugin directory

Returns: QSharedPointer<QTranslator>

See also: CDir::GetDirTranslations cmake/Translations.cmake

Definition at line 339 of file RabbitCommonTools.cpp.

◆ InstallTranslatorFile()

QSharedPointer< QTranslator > RabbitCommon::CTools::InstallTranslatorFile ( const QString szFile )

private

Definition at line 313 of file RabbitCommonTools.cpp.

◆ Instance()

CTools * RabbitCommon::CTools::Instance ( )

static

Definition at line 107 of file RabbitCommonTools.cpp.

◆ IsStartRun()

bool RabbitCommon::CTools::IsStartRun	(	const QString &	szName = `QString()`,
		bool	bAllUser = `false`
	)

static

Definition at line 512 of file RabbitCommonTools.cpp.

◆ RemoveStartRun()

int RabbitCommon::CTools::RemoveStartRun	(	const QString &	szName = `QString()`,
		bool	bAllUser = `false`
	)

static

Definition at line 489 of file RabbitCommonTools.cpp.

◆ RemoveTranslator()

int RabbitCommon::CTools::RemoveTranslator ( QSharedPointer< QTranslator > translator )

Definition at line 395 of file RabbitCommonTools.cpp.

◆ SetLanguage()

int RabbitCommon::CTools::SetLanguage ( const QString szLanguage )

Definition at line 115 of file RabbitCommonTools.cpp.

◆ Version()

QString RabbitCommon::CTools::Version ( )

static

RabbitCommon version.

Definition at line 128 of file RabbitCommonTools.cpp.

Member Data Documentation

◆ m_Initialized

bool RabbitCommon::CTools::m_Initialized

private

Definition at line 246 of file RabbitCommonTools.h.

◆ m_szLanguage

QString RabbitCommon::CTools::m_szLanguage

private

Definition at line 245 of file RabbitCommonTools.h.

◆ m_Translator

QVector<QSharedPointer<QTranslator> > RabbitCommon::CTools::m_Translator

private

Definition at line 243 of file RabbitCommonTools.h.

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

/home/runner/work/RabbitCommon/RabbitCommon/Src/RabbitCommonTools.h
/home/runner/work/RabbitCommon/RabbitCommon/App/main.cpp
/home/runner/work/RabbitCommon/RabbitCommon/Src/RabbitCommonTools.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ TranslationType

Constructor & Destructor Documentation

◆ CTools()

◆ ~CTools()

Member Function Documentation

◆ AndroidRequestPermission() [1/2]

◆ AndroidRequestPermission() [2/2]

◆ Clean()

◆ CleanResource()

◆ EnableCoreDump()

◆ executeByRoot()

◆ GenerateDesktopFile()

◆ GetCurrentUser()

◆ GetHostName()

◆ GetLanguage()

◆ Information()

◆ Init()

◆ InitResource()

◆ InstallStartRun()

◆ InstallTranslator()

◆ InstallTranslatorFile()

◆ Instance()

◆ IsStartRun()

◆ RemoveStartRun()

◆ RemoveTranslator()

◆ SetLanguage()

◆ Version()

Member Data Documentation

◆ m_Initialized

◆ m_szLanguage

◆ m_Translator