Kdelibs4ConfigMigrator

Search for usage in LXR

Kdelibs4ConfigMigrator Class Reference

#include <Kdelibs4ConfigMigrator>

Public Member Functions

 Kdelibs4ConfigMigrator (const QString &appName)
 
 Kdelibs4ConfigMigrator (const Kdelibs4ConfigMigrator &)=delete
 
 ~Kdelibs4ConfigMigrator ()
 
bool migrate ()
 
Kdelibs4ConfigMigratoroperator= (const Kdelibs4ConfigMigrator &)=delete
 
void setConfigFiles (const QStringList &configFileNameList)
 
void setUiFiles (const QStringList &uiFileNameList)
 

Detailed Description

Kdelibs4ConfigMigrator migrates selected config files and ui files from the kdelibs 4.x location ($KDEHOME, as used by KStandardDirs) to the Qt 5.x location ($XDG_*_HOME, as used by QStandardPaths).

Class for migration of config files and ui file from kdelibs4.

Since
5.2

Definition at line 26 of file kdelibs4configmigrator.h.

Constructor & Destructor Documentation

Kdelibs4ConfigMigrator::Kdelibs4ConfigMigrator ( const QString appName)
explicit

Constructs a Kdelibs4ConfigMigrator.

Parameters
appNameThe application name, which is used for the directory containing the .ui files.

Definition at line 36 of file kdelibs4configmigrator.cpp.

Kdelibs4ConfigMigrator::~Kdelibs4ConfigMigrator ( )
default

Destructor.

Member Function Documentation

bool Kdelibs4ConfigMigrator::migrate ( )

Migrate the files, if any.

Returns true if the migration happened. It will return false if there was nothing to migrate (no KDEHOME). This return value is unrelated to error handling. It is just a way to skip anything else related to migration on a clean system, by writing

if (migrate()) {
look for old data to migrate as well
}

Definition at line 53 of file kdelibs4configmigrator.cpp.

void Kdelibs4ConfigMigrator::setConfigFiles ( const QStringList configFileNameList)

Set the list of config files that need to be migrated.

Parameters
configFileNameListlist of config files

Definition at line 43 of file kdelibs4configmigrator.cpp.

void Kdelibs4ConfigMigrator::setUiFiles ( const QStringList uiFileNameList)

Set the list of ui files to migrate.

Parameters
uiFileNameListlist of ui files

Definition at line 48 of file kdelibs4configmigrator.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Jul 30 2021 23:02:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.