projectsubstitute.h

Go to the documentation of this file.

#ifndef PROJECTSUBSTITUTE_H
#define PROJECTSUBSTITUTE_H
 
#include <QObject>
 
//#include <mainwindow.h>
#include "logger.h"
#include "projectoptionsmanager.h"

#define DEFAULT_RETURN_ADDRESS "https://www.little.id.au/projects/index.php"
 

enum PROJECT_ITEM
{
    PROJECT_NAME,           
    PROJECT_IDENT,          
    MAJOR_VERSION,          
    MINOR_VERSION,          
    REVISION,               
    BRIEF_DESCRIPTION,      
    DEV_FAMILY,             
    LANGUAGE_FAMILY,        
    PRIMARY_TOOL,           
    SYSTEM_FAMILY,          
    PROJECT_STATUS,         
    PROJECT_HISTORY,        
    STATUS_DATE,            
    DOCUMENT_LICENCE,       
    SOFTWARE_LICENCE,       
    HARDWARE_LICENCE,       
    PROJECT_CONTACT,        
    PROJECT_EMAIL,          
    FULL_DESCRIPTION,       
    PROJECT_DIRECTORY,      
    PROJECT_ICON,           
    DOXY_LOGO,              
    DOXY_HTML_HEADER,       
    DOXY_HTML_FOOTER,       
    DOXY_EXTRA_STYLESHEET,  
    ASSOCIATED_GROUP,       
    DEPARTURE_URL,          
    SITE_URL,               
    EXECUTABLE_DIR,         
    SOURCE_LIST,            
 
    // Place new items above this line & Update StringList
    PROJECT_ITEM_END        
};

#define MAXIMUM_KEY_VALUE_PAIRS     60

#define PROJECT_KEY_COLUMN_WIDTH    150

class ProjectSubstitute  : public QObject
{
    Q_OBJECT
public:

    explicit ProjectSubstitute(Ui::MainWindow* UI_Window, ProjectOptionsManager* ProjectOptsManager);

    void LoadFileSubsList(PROJECT_INFORMATION* Project);
 
public slots:

    void DoClear(void);
 
    /* \fn void LoadSubsTable(int ProjectNo)
     * \brief Load the Substituitions from the Values in the User Interface
     *  \param ProjectNo The Project Database Index
     *
     *  If the ProjectNo is set to zero, the values in the
     *  substitution table are cleared.
     *
     */
    void LoadSubsTable(int ProjectNo);

    void ReadProjectId(PROJECT_INFORMATION* ProjectInfo);

    void UpdateVersion(REMOTE_VERSION_ENTRY Version);

    void UpdateDevFamily(DEVELOPMENT_FAMILY DevelopmentTypes);

    void UpdateStatus(STATUS_INFO StatusInfo);

    void SaveLocalSubstitutes(void);

    void UpdateSoftwareLicence(QString LicenceName);

    void UpdateHardwareLicence(QString LicenceName);

    void UpdateDocumentationLicence(QString LicenceName);

    void UpdateFullDescription(QString FullDescription);

    void ReadMajorVersion(int MajorVersion);

    void ReadMinorVersion(int MinorVersion);

    void ReadRevision(int Revision);

    void UpdateProjectName(QString Name);

    void UpdateDepartureURL(QString Name);

    void UpdateProjectIcon(QString Name);

    void UpdateProjectBrief(QString Text);

    void UpdateProjectContact(QString ContactName);

    void UpdateProjectDateTime(QString ProjectDateTime);

    void UpdateDoxyProjectLogo(QString DoxyProjectLogo);

    void UpdateDoxyHeader(QString DoxyHeader);

    void UpdateDoxyFooter(QString DoxyFooter);

    void UpdateDoxyStylesheet(QString DoxyStylesheet);

    void UpdateInAssocation(QString Association);

    void LoadPresets(void);
 
private:

    Ui::MainWindow* ui;

    PROJECT_INFORMATION* project_info;

    QString leadin_string;

    QString leadout_string;

    QColor system_colour;

    ProjectOptionsManager* project_opts_manager;

    QStringList option_name;

    QStringList sys_item_name;

    QTableWidgetItem*  FindItemByKey(QString Key);

    bool UpdateItem(QString Key, QString Value);

    void LogAdd(LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message);

    void AddKeyValue(QString Key, QString Value, int RowIndex);

    int  DecodeProjectOptions(uint Options, int RowIndex, bool NewProject);
    bool SaveKeyValuePair(int ProjectId, QString Key, QString Value, bool Lock);
    void LoadBasePresets(int RowIndex, int ProjectNo);
    QString GetProjectEmail(int Index);
    void LoadUserSubstitutes(PROJECT_INFORMATION* Project);
 
private slots:

    void ReloadSubstituteTable(void);

    void ClearSubstituteEntry(void);
    void SetSubstituteState(bool State);
    void SetOptionState(uint Options);
    void SetEditableState(QTableWidgetItem* Item);
 
signals:
     void SendLogEntry(REMOTE_LOG_ENTRY LogEntry);
};
 
#endif // PROJECTSUBSTITUTE_H