mirror of
https://github.com/QuasarApp/CopyrightFixer.git
synced 2025-05-13 18:09:44 +00:00
70 lines
1.8 KiB
C++
70 lines
1.8 KiB
C++
//#
|
|
//# Copyright (C) 2021-2021 QuasarApp.
|
|
//# Distributed under the lgplv3 software license, see the accompanying
|
|
//# Everyone is permitted to copy and distribute verbatim copies
|
|
//# of this license document, but changing it is not allowed.
|
|
//#
|
|
|
|
#ifndef SIGN_H
|
|
#define SIGN_H
|
|
|
|
#include "CopyrighFixer_global.h"
|
|
#include "CopyrighFixer/owner.h"
|
|
#include <QList>
|
|
|
|
|
|
namespace CopyrighFixer {
|
|
|
|
/**
|
|
* @brief The Signature class adds a copyright signature to each file based on the collected owner information.
|
|
*/
|
|
class CopyrighFixer_EXPORT Signature {
|
|
public:
|
|
Signature();
|
|
|
|
/**
|
|
* @brief setlistOwners The method generates a list of owners.
|
|
* @param objOwner This is a structure with information about the owner.
|
|
*/
|
|
void setlistOwners(const QList<Owner> &objOwner);
|
|
|
|
/**
|
|
* @brief setLicenseTitle The method sets the copyright message.
|
|
* @param strTitle A string that contains copyright information.
|
|
*/
|
|
void setLicenseTitle(const QString &strTitle);
|
|
|
|
/**
|
|
* @brief setMessage Method adds custom message.
|
|
* @param strMsg Meaningful message with complementary information.
|
|
*/
|
|
void setMessage(const QString &strMsg);
|
|
|
|
/**
|
|
* @brief getLstOwn The method allows you to get the current list of owners.
|
|
* @return List of owners with full information.
|
|
*/
|
|
const QList<Owner>& getLstOwn() const;
|
|
|
|
/**
|
|
* @brief getLicenseTitle Allows you to get a license description.
|
|
* @return A string with license title.
|
|
*/
|
|
const QString& getLicenseTitle() const;
|
|
|
|
/**
|
|
* @brief getMessage The method retutns a custom message with additional information.
|
|
* @return Custom message.
|
|
*/
|
|
const QString& getMessage() const;
|
|
|
|
private:
|
|
QList<Owner> _ownersList;
|
|
QString _licenseTitle;
|
|
QString _customMessage;
|
|
};
|
|
|
|
}
|
|
|
|
#endif // SIGN_H
|