#include <projectlistmanager.h>

Inheritance diagram for ProjectListManager:

Collaboration diagram for ProjectListManager:

Public Slots
void	ProjectTabChanged (int Index)
	Process the Change in Window Tab.
void	LoadProjectTable (void)
	Clear and Reload the Project table, Sort by Selected Button \SortButton Button pressed to sort the Table List.
void	ProcessFullList (void)
	Add all Projects for Documentation Creation.
void	ProcessSelection (void)
	Add th Selected Project for Documentation Creation.
void	PrStateChange (PROJECT_INFORMATION *Project)
	Update the Lock/Queued Status of Project in the Project List Table.

Signals
void	SendLogEntry (REMOTE_LOG_ENTRY log_entry)

Public Member Functions
	ProjectListManager (Ui::MainWindow *UI_Window)
	Project List Manager Class Constructor.
	~ProjectListManager ()
	Project List Manager Class Destructor.
QString	MakeHTMLProjectPage (QString HeaderTemplateFile, QString FooterTemplateFile, QString LineTemplateFile, bool TableOnly=true)
QString	MakeOSProjectPage (void)

Private Slots
void	PressedInstallOff (void)
	Turn all Install Check boxes off in List table.
void	PressedInstallOn (void)
	Turn all Install Check boxes on in List table.
void	PressedArchiveOff (void)
	Turn all Archive Check boxes off in List table.
void	PressedArchiveOn (void)
	Turn all Archive Check boxes on in List table.

Private Member Functions
void	InitaliseProjectTable (void)
	Clear and Load the Project List Table.
void	SetMaximumProjects (void)
	Set the Initial Line Count in the Project List table.
QString	ReadTableTemplate (QString TemplateFile)
	Read an HTML template from a File.
bool	WriteTextFile (QString FileName, QString Contents)
	Write a String to a File.
int	FindSelections (int index)
	Read and Encode selected options for a Project.
void	SetCheckState (int column, bool InstallState)
	Set the State of all Project Selection in Table List.
void	LogAdd (LOGGING_SEVERITY Severity, LOGGING_MODE Mode, QString Message)
	Send Message to the Log.

Private Attributes
Ui::MainWindow *	ui
QButtonGroup *	sort_group
	Pointer to Button Group for sorting Project List Table.
QString	base_project_query
	Basic SQL Query for listing Projects.
QList< PROJECT_INFORMATION * >	ProjectList
	A list of Projects to be processed.

Detailed Description

Definition at line 131 of file projectlistmanager.h.

Constructor & Destructor Documentation

◆ ProjectListManager()

ProjectListManager::ProjectListManager ( Ui::MainWindow * UI_Window )

Project List Manager Class Constructor.

Parameters

UI_Window Pointer to the Main Window

Definition at line 15 of file projectlistmanager.cpp.

{
    ProjectList.clear();
    ui = UI_Window;
    QObject::connect(ui->AutoInstallOff, SIGNAL(pressed()), this, SLOT(PressedInstallOff()));
    QObject::connect(ui->AutoInstallOn,  SIGNAL(pressed()), this, SLOT(PressedInstallOn()));
 
    QObject::connect(ui->AutoArchiveOff, SIGNAL(pressed()), this, SLOT(PressedArchiveOff()));
    QObject::connect(ui->AutoArchiveOn,  SIGNAL(pressed()), this, SLOT(PressedArchiveOn()));
 
    base_project_query = QString("select project_index from project where project_index != 1");
 
    ui->ProjectTableWidget->setColumnCount( TABLE_COLUMN_COUNT );
    SetMaximumProjects();
 
    ui->ProjectTableWidget->setHorizontalHeaderLabels( QStringList( {"Proj. Ident", "Proj. Name", "Target", "Status", "Proj. Contact", "Brief Desc.", "Dev. Family", "Comp. Lang.", "Assoc Group",
                                                                     "S/W Licence", "H/W Licence", "Doc Licence", "Inst", "Arch", "Publish"} ));
 
    ui->ProjectTableWidget->setColumnWidth( PROJECT_IDENT_COLUMN,    PROJECT_IDENT_SIZE );
    ui->ProjectTableWidget->setColumnWidth( PROJECT_NAME_COLUMN,     PROJECT_NAME_SIZE );
    ui->ProjectTableWidget->setColumnWidth( TARGET_FAMILY_COLUMN,    TARGET_FAMILY_SIZE );
    ui->ProjectTableWidget->setColumnWidth( PROJECT_CONTACT_COLUMN,  PROJECT_CONTACT_SIZE );
    ui->ProjectTableWidget->setColumnWidth( PROJECT_STATUS_COLUMN,   PROJECT_STATUS_SIZE);
    ui->ProjectTableWidget->setColumnWidth( BRIEF_DESC_COLUMN,       BRIEF_DESC_SIZE );
    ui->ProjectTableWidget->setColumnWidth( DEV_FAMILY_COLUMN,       DEV_FAMILY_SIZE );
    ui->ProjectTableWidget->setColumnWidth( COMPILER_FAMILY_COLUMN,  COMPILER_FAMILY_SIZE );
    ui->ProjectTableWidget->setColumnWidth( ASSOCIATION_COLUMN,      ASSOCIATION_SIZE );
    ui->ProjectTableWidget->setColumnWidth( SOFTWARE_LICENCE_COLUMN, SOFTWARE_LICENCE_SIZE );
    ui->ProjectTableWidget->setColumnWidth( HARDWARE_LICENCE_COLUMN, HARDWARE_LICENCE_SIZE );
    ui->ProjectTableWidget->setColumnWidth( DOC_LICENCE_COLUMN,      DOC_LICENCE_SIZE );
    ui->ProjectTableWidget->setColumnWidth( ARCHIVE_BUTTON_COLUMN,   ARCHIVE_BUTTON_SIZE );
    ui->ProjectTableWidget->setColumnWidth( INSTALL_BUTTON_COLUMN,   INSTALL_BUTTON_SIZE );
    ui->ProjectTableWidget->setColumnWidth( PUBLISH_BUTTON_COLUMN,   PUBLISH_BUTTON_SIZE );
}

References ARCHIVE_BUTTON_COLUMN, ARCHIVE_BUTTON_SIZE, ASSOCIATION_COLUMN, ASSOCIATION_SIZE, base_project_query, BRIEF_DESC_COLUMN, BRIEF_DESC_SIZE, COMPILER_FAMILY_COLUMN, COMPILER_FAMILY_SIZE, DEV_FAMILY_COLUMN, DEV_FAMILY_SIZE, DOC_LICENCE_COLUMN, DOC_LICENCE_SIZE, HARDWARE_LICENCE_COLUMN, HARDWARE_LICENCE_SIZE, INSTALL_BUTTON_COLUMN, INSTALL_BUTTON_SIZE, PressedArchiveOff(), PressedArchiveOn(), PressedInstallOff(), PressedInstallOn(), PROJECT_CONTACT_COLUMN, PROJECT_CONTACT_SIZE, PROJECT_IDENT_COLUMN, PROJECT_IDENT_SIZE, PROJECT_NAME_COLUMN, PROJECT_NAME_SIZE, PROJECT_STATUS_COLUMN, PROJECT_STATUS_SIZE, ProjectList, PUBLISH_BUTTON_COLUMN, PUBLISH_BUTTON_SIZE, SetMaximumProjects(), SOFTWARE_LICENCE_COLUMN, SOFTWARE_LICENCE_SIZE, TABLE_COLUMN_COUNT, TARGET_FAMILY_COLUMN, TARGET_FAMILY_SIZE, and ui.

Here is the call graph for this function:

◆ ~ProjectListManager()

ProjectListManager::~ProjectListManager ( void )

Project List Manager Class Destructor.

Definition at line 51 of file projectlistmanager.cpp.

{
 
}

Member Function Documentation

◆ FindSelections()

int ProjectListManager::FindSelections ( int index )

private

Read and Encode selected options for a Project.

Parameters

index The row index in the Project List Table

Returns: Ecoded Selected Options for the Project

Definition at line 238 of file projectlistmanager.cpp.

{
    int selections = 0;
 
    QCheckBox* check_widget = (QCheckBox*)ui->ProjectTableWidget->cellWidget(index, ARCHIVE_BUTTON_COLUMN);
    if (check_widget->isChecked())
    {
        selections |= CREATE_SOURCE_ARCHIVE;
    }
 
    check_widget = (QCheckBox*)ui->ProjectTableWidget->cellWidget(index, INSTALL_BUTTON_COLUMN);
    if (check_widget->isChecked())
    {
        selections |= INSTALL_SCRIPT_MASK;
    }
 
    check_widget = (QCheckBox*)ui->ProjectTableWidget->cellWidget(index, PUBLISH_BUTTON_COLUMN);
    if (check_widget->isChecked())
    {
        selections |= INSTALL_SCRIPT_MASK;
    }
 
 
    return(selections);
}

References ARCHIVE_BUTTON_COLUMN, CREATE_SOURCE_ARCHIVE, INSTALL_BUTTON_COLUMN, INSTALL_SCRIPT_MASK, PUBLISH_BUTTON_COLUMN, and ui.

Referenced by ProcessSelection().

Here is the caller graph for this function:

◆ InitaliseProjectTable()

void ProjectListManager::InitaliseProjectTable ( void )

private

Clear and Load the Project List Table.

Definition at line 85 of file projectlistmanager.cpp.

{
    LoadProjectTable();
}

References LoadProjectTable().

Referenced by ProjectTabChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LoadProjectTable

void ProjectListManager::LoadProjectTable ( void )

slot

Clear and Reload the Project table, Sort by Selected Button \SortButton Button pressed to sort the Table List.

Definition at line 90 of file projectlistmanager.cpp.

{
    ProjectList.clear();
    SetMaximumProjects();
    QString sort_type;
    sort_type = QString(" order by project_ident desc");
    QString query_string = base_project_query + sort_type;
 
    // Clear the Table Widget before Starting to Add Projects
    ui->ProjectTableWidget->clearContents();
    ui->ProjectTableWidget->setEnabled(true);
 
    // Search for the Project List
       QSqlQuery project_query(query_string);
 
    int row = 0;
    while( project_query.next())
    {
        PROJECT_INFORMATION* project_file_info = new PROJECT_INFORMATION;
 
        // Load all of the Data about this Project
        read_project_info->LoadProjectInfo(project_file_info, project_query.value(0).toInt(), ui->ProjectPrefix->currentIndex() + 1);
        project_subs_manager->LoadFileSubsList(project_file_info);
        ProjectList.append(project_file_info);
 
        // Make A Table Widget for the Project Identifier and Insert
        QTableWidgetItem *new_project_ident = new QTableWidgetItem(project_file_info->ProjectDesc.ProjectIdent);
        new_project_ident->setFlags(new_project_ident->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, PROJECT_IDENT_COLUMN, new_project_ident );
        PrStateChange (project_file_info);
 
        // Make A Table Widget for the Project Name and Insert
        QTableWidgetItem *new_project_name = new QTableWidgetItem(project_file_info->ProjectDesc.ProjectName);
        new_project_name->setFlags(new_project_name->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, PROJECT_NAME_COLUMN, new_project_name );
 
        // Make A Table Widget for the Target System and Insert
        QTableWidgetItem *new_target_system = new QTableWidgetItem(project_file_info->TargetFamilyInfo.ShortName);
        new_target_system->setFlags(new_target_system->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, TARGET_FAMILY_COLUMN, new_target_system );
 
        // Get the DEveloper Name, Create Table Widget and Insert in Table
        QTableWidgetItem *new_project_contact = new QTableWidgetItem(project_file_info->Developer.Name);
        new_project_contact->setFlags(new_project_contact->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, PROJECT_CONTACT_COLUMN, new_project_contact );
 
        // Get the Project Status Name, Create Table Widget and Insert in Table
        QTableWidgetItem *new_project_status = new QTableWidgetItem(project_file_info->StatusInfo.StatusName);
        new_project_status->setFlags(new_project_status->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, PROJECT_STATUS_COLUMN, new_project_status );
 
        // Get the Brief Description, Create Table Widget and Insert in Table
        QTableWidgetItem *new_brief_desc = new QTableWidgetItem(project_file_info->ProjectDesc.BriefDescription);
        new_brief_desc->setFlags(new_project_ident->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, BRIEF_DESC_COLUMN, new_brief_desc );
 
        // Get the Development Family, Create Table Widget and Insert in Table
        QTableWidgetItem *new_dev_family = new QTableWidgetItem(project_file_info->DevFamilyInfo.ShortName);
        new_dev_family->setFlags(new_dev_family->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, DEV_FAMILY_COLUMN, new_dev_family );
 
        // Get the Compiler Family, Create Table Widget and Insert in Table
        QTableWidgetItem *new_comp_family = new QTableWidgetItem(project_file_info->LangFamilyInfo.ShortName);
        new_comp_family->setFlags(new_comp_family->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, COMPILER_FAMILY_COLUMN, new_comp_family );
 
        // Get the Association Family, Create Table Widget and Insert in Table
        QTableWidgetItem *new_assoc_family = new QTableWidgetItem(project_file_info->InAssocInfo.ShortName);
        new_assoc_family->setFlags(new_assoc_family->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, ASSOCIATION_COLUMN, new_assoc_family );
 
        // Get the Software Licence, Create Table Widget and Insert in Table
        QTableWidgetItem *new_software_licence = new QTableWidgetItem(project_file_info->SoftwareLicence.ShortName);
        new_software_licence->setFlags(new_software_licence->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, SOFTWARE_LICENCE_COLUMN, new_software_licence );
 
        // Get the Software Licence, Create Table Widget and Insert in Table
        QTableWidgetItem *new_hardware_licence = new QTableWidgetItem(project_file_info->HardwareLicence.ShortName);
        new_hardware_licence->setFlags(new_hardware_licence->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, HARDWARE_LICENCE_COLUMN, new_hardware_licence );
 
        // Get the Documentation Licence, Create Table Widget and Insert in Table
        QTableWidgetItem *new_doc_licence = new QTableWidgetItem(project_file_info->DocLicence.ShortName);
        new_doc_licence->setFlags(new_doc_licence->flags() & ~(Qt::ItemIsEditable | Qt::ItemIsSelectable));
        ui->ProjectTableWidget->setItem( row, DOC_LICENCE_COLUMN, new_doc_licence );
        QWidget *check_box_widget1 = new QWidget();
        QCheckBox *install_button  = new QCheckBox();
        install_button->setText("");
        install_button->setChecked((project_file_info->ProjectDesc.ProjectOptions & ALLOW_AUTOMATIC_INSTALL));
        install_button->setCheckable((project_file_info->ProjectDesc.ProjectOptions & ALLOW_AUTOMATIC_INSTALL));
        QHBoxLayout *layout_check_box1 = new QHBoxLayout( check_box_widget1 );
        layout_check_box1->addWidget(install_button);     //add QCheckBox to layout
        layout_check_box1->setAlignment(Qt::AlignCenter); //set Alignment layout
        layout_check_box1->setContentsMargins(0,0,0,0);
        ui->ProjectTableWidget->setCellWidget( row, INSTALL_BUTTON_COLUMN, check_box_widget1);
 
        QWidget *check_box_widget2 = new QWidget();
        QCheckBox *archive_button  = new QCheckBox();
        archive_button->setText("");
        archive_button->setChecked((project_file_info->ProjectDesc.ProjectOptions & CREATE_SOURCE_ARCHIVE));
        archive_button->setCheckable((project_file_info->ProjectDesc.ProjectOptions & CREATE_SOURCE_ARCHIVE));
        QHBoxLayout *layout_check_box2 = new QHBoxLayout( check_box_widget2 );
        layout_check_box2->addWidget(archive_button);     //add QCheckBox to layout
        layout_check_box2->setAlignment(Qt::AlignCenter); //set Alignment layout
        layout_check_box2->setContentsMargins(0,0,0,0);
        ui->ProjectTableWidget->setCellWidget( row, ARCHIVE_BUTTON_COLUMN, check_box_widget2);
 
        QWidget *check_box_widget3 = new QWidget();
        QCheckBox *publish_button  = new QCheckBox();
        archive_button->setText("");
        QHBoxLayout *layout_check_box3 = new QHBoxLayout( check_box_widget3 );
        layout_check_box3->addWidget(publish_button);     //add QCheckBox to layout
        layout_check_box3->setAlignment(Qt::AlignCenter); //set Alignment layout
        layout_check_box3->setContentsMargins(0,0,0,0);
        ui->ProjectTableWidget->setCellWidget( row, PUBLISH_BUTTON_COLUMN, check_box_widget3);
 
        // Next Row
        row++;
    }
    ui->ProjectTableWidget->setEnabled(true);
}

Referenced by InitaliseProjectTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogAdd()

void ProjectListManager::LogAdd	(	LOGGING_SEVERITY	Severity,
		LOGGING_MODE	Mode,
		QString	Message )

private

Send Message to the Log.

Parameters

Severity	Severity of the Log Message
Mode	Which part of the program does the message relate to
Message	Text message to be added to the Log

Definition at line 276 of file projectlistmanager.cpp.

{
    REMOTE_LOG_ENTRY log_entry;
    log_entry.Severity = Severity;
    log_entry.Mode = Mode;
    log_entry.Message = Message;
    emit SendLogEntry(log_entry);
}

References REMOTE_LOG_ENTRY::Message, REMOTE_LOG_ENTRY::Mode, SendLogEntry(), and REMOTE_LOG_ENTRY::Severity.

Referenced by MakeHTMLProjectPage(), PrStateChange(), and WriteTextFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeHTMLProjectPage()

QString ProjectListManager::MakeHTMLProjectPage	(	QString	HeaderTemplateFile,
		QString	FooterTemplateFile,
		QString	LineTemplateFile,
		bool	TableOnly = true )

Definition at line 313 of file projectlistmanager.cpp.

{
    QString project_html_header;
    QString project_html_line;
    QString project_html_footer;
 
    QString project_line;
    QString project_table_html;
 
    // Substitution Strings
    QString p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, pa, pb, pc;
 
 
    if (QFileInfo::exists(HeaderTemplateFile) && !TableOnly)
    {
        project_html_line = ReadTableTemplate(HeaderTemplateFile);
        LogAdd(LOG_DEBUG, MODE_FILE, QString("Read Project List Header Template %1.").arg(HeaderTemplateFile));
    }
    else
    {
        // Initialise the HTML Table Header Template with Default
        if (!TableOnly)
        {
            project_html_header =
            QString("<!doctype html><html lang=\"en-au\">") +
            QString("<head><meta charset=\"utf-8\">") +
            QString("<title>Brigadoon Project List</title>") +
            QString("<meta name=\"author\" content=\"RiverPirate\">") +
            QString("<meta name=\"robots\" content=\"index, follow\">") +
            QString("<meta name=\"revisit-after\" content=\"30 days\">") +
            QString("<meta name=\"generator\" content=\"ProjectManager\">") +
            QString("<meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">") +
            QString("</head>") +
            QString("<body>");
        }
            project_html_header +=
            QString("<div Class=\"Title\">") +
            QString("<span style=\"color:#000000;font-family:Arial;font-size:100px;\">BRIGADOON</span>") +
            QString("</div>") +
            QString("<DIV CLASS=\"ProjListTable\">") +
            QString("<TABLE WIDTH=\"100%\" BORDER=\"1\"><TR>") +
            QString("<TH>Prj. Ident.</TH><TH>Prj. Name</TH><TH>Target</TH><TH>Stat.</TH><TH>Contact</TH><TH>Brief Description</TH>") +
            QString("<TH>Dev. Fam.</TH><TH>Comp. Lang.</TH><TH>Assoc. Grp.</TH>") +
            QString("<TH>S/W Lic.</TH><TH>H/W Lic.</TH><TH>Doc.Lic.</TH>") +
            QString("</TR>");
 
        LogAdd(LOG_INFO, MODE_FILE, QString("Unable to Read Project List Header Template %1, using Default Template.").arg(HeaderTemplateFile));
    }
 
    if (QFileInfo::exists(LineTemplateFile))
    {
        project_html_line = ReadTableTemplate(LineTemplateFile);
        LogAdd(LOG_DEBUG, MODE_FILE, QString("Read Project List Line Template %1.").arg(LineTemplateFile));
    }
    else
    {
        project_html_line =
            QString("<TR>") +
            QString("<TD>%1</TD><TD>%2</TD><TD>%3</TD><TD>%4</TD>") +
            QString("<TD>%5</TD><TD>%6</TD><TD>%7</TD><TD>%8</TD>") +
            QString("<TD>%9</TD><TD>%10</TD><TD>%11</TD><TD>%12</TD>") +
            QString("</TR>");
        LogAdd(LOG_INFO, MODE_FILE, QString("Unable to Read Project List Line Template %1, using Default Template.").arg(LineTemplateFile));
    }
 
    if (QFileInfo::exists(FooterTemplateFile))
    {
        project_html_line = ReadTableTemplate(FooterTemplateFile);
        LogAdd(LOG_DEBUG, MODE_FILE, QString("Read Project List Footer Template %1.").arg(FooterTemplateFile));
    }
    else
    {
        project_html_footer = QString("</TABLE></DIV>");
        if (!TableOnly) project_html_footer += "</BODY></HTML>";
 
        LogAdd(LOG_INFO, MODE_FILE, QString("Unable to Read Project List Footer Template %1, using Default Template.").arg(FooterTemplateFile));
    }
 
    // Start Creating table
    project_table_html = project_html_header;
 
    // Retreive the List of Projects
    QString query_string = base_project_query;
    QSqlQuery project_query(query_string + " order by project_index desc");
 
    // Step Through the List of Projects
    while( project_query.next())
    {
        PROJECT_INFORMATION* project_info = new PROJECT_INFORMATION;
 
        // Load all of the Data about this Project
        read_project_info->LoadProjectInfo(project_info, project_query.value(0).toInt(), ui->ProjectPrefix->currentIndex() + 1);
 
        if (!(project_info->ProjectDesc.ProjectOptions & EXCLUDE_PROJECT_LIST))
        {
 
            // Get the Project's URL and Project Identifier
            pa = project_info->ProgramInformation.SiteURL + "/project_dynamic/" + project_info->ProjectDesc.ProjectIdent + "/html/index.html";
            pb = project_info->ProjectDesc.ProjectIdent;
            p1 = QString("<A HREF=\"")+pa + "\">" + pb + "</A>";
 
            // Make A Table Widget for the Project Name and Insert
            p2 = project_info->ProjectDesc.ProjectName;
 
            // Get the Name of the target System
            p3 = project_info->TargetFamilyInfo.ShortName;
 
            // Get the Project Status Name, Create Table Widget and Insert in Table
            p4 = project_info->StatusInfo.StatusName;
 
            // Get the Developer Name, Create Table Widget and Insert in Table
            pa = project_info->Developer.Email;
            pb = project_info->Developer.Handle;
            pc = project_info->ProjectDesc.ProjectIdent;
            p5 = QString("<A HREF=\"mailto:") + pa +"?subject=re: " + pc + " Project.\">"  + pb + "</A>";
 
            // Get the Brief Description, Create Table Widget and Insert in Table
            p6 = project_info->ProjectDesc.BriefDescription;
 
            // Get the Development Family, Create Table Widget and Insert in Table
            p7 = project_info->DevFamilyInfo.ShortName;
 
            // Get the Language Family, Create Table Widget and Insert in Table
            p8 = project_info->LangFamilyInfo.ShortName;
 
            // Get the Association Family, Create Table Widget and Insert in Table
            pa = project_info->InAssocInfo.ShortName;
            if (project_info->InAssocInfo.InAssociationIndex != 0)
            {
                pb = project_info->InAssocInfo.AssociationURL;
                p9 = QString("<A HREF=\"")+ pb + QString("\" target=\"_blank\">") + pa + "</A>";
            }
            else
            {
                p9 = pa;
            }
 
            // Get the Software Licence, Create Table Widget and Insert in Table
            pa = project_info->SoftwareLicence.ShortName;
            if( project_info->SoftwareLicence.LicenceIndex != 14)
            {
                pb = project_info->SoftwareLicence.LicenceURL;
                p10 = QString("<A HREF=\"")+ pb + QString("\" target=\"_blank\">") + pa + "</A>";
            }
            else
            {
                p10 = pa;
            }
 
            // Get the Hardware Licence, Create Table Widget and Insert in Table
            pa = project_info->HardwareLicence.ShortName;
            if( project_info->HardwareLicence.LicenceIndex != 14)
            {
                pb = project_info->HardwareLicence.LicenceURL;
                p11 = QString("<A HREF=\"")+ pb + QString("\" target=\"_blank\">") + pa + "</A>";
            }
            else
            {
                p11 = pa;
            }
 
            // Get the Documentation Licence, Create Table Widget and Insert in Table
            pa = project_info->DocLicence.ShortName;
            if( project_info->DocLicence.LicenceIndex != 14)
            {
                pb = project_info->DocLicence.LicenceURL;
                p12 = QString("<A HREF=\"")+ pb + QString("\" target=\"_blank\">") + pa + "</A>";
            }
            else
            {
                p12 = pa;
            }
 
            project_line = project_html_line.arg(p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12);
            project_table_html += project_line;
        }
    }
    project_table_html += project_html_footer;
 
    // Write the Table Out to a File
 
 
    return(project_table_html);
}

Referenced by ProjectTabChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeOSProjectPage()

QString ProjectListManager::MakeOSProjectPage ( void )

Definition at line 285 of file projectlistmanager.cpp.

{
    QString project_line;
    QString project_table_opensim;
 
    // Retreive the List of Projects
    QString query_string = base_project_query;
    QSqlQuery project_query(query_string + " order by project_name");
 
    // Step Through the List of Projects
    while( project_query.next())
    {
        PROJECT_INFORMATION* project_info = new PROJECT_INFORMATION;
        read_project_info->LoadProjectInfo(project_info, project_query.value(0).toInt(), ui->ProjectPrefix->currentIndex() + 1);
 
        uint options = project_info->ProjectDesc.ProjectOptions;
        if ((options & (1 <<EXCLUDE_PROJECT_LIST_BIT)) == 0)
        {
            QString project_address = project_info->ProgramInformation.SiteURL + "/project_dynamic/" + project_info->ProjectDesc.ProjectIdent + "/html/index.html";
            QString project_logo    = project_info->ProgramInformation.SiteURL + "/project_dynamic/" + project_info->ProjectDesc.ProjectIdent + "/images/os_logo.png";
            project_line = project_info->ProjectDesc.ProjectName + "=" + project_address + "=" + project_logo + "\r\n";
            project_table_opensim += project_line;
        }
        delete project_info;
    }
    return(project_table_opensim);
}

References base_project_query, EXCLUDE_PROJECT_LIST_BIT, PROJECT_INFORMATION::ProgramInformation, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIdent, PROJECT_DESCRIPTION::ProjectName, PROJECT_DESCRIPTION::ProjectOptions, read_project_info, PROGRAM_INFORMATION::SiteURL, and ui.

Referenced by ProjectTabChanged().

Here is the caller graph for this function:

◆ PressedArchiveOff

void ProjectListManager::PressedArchiveOff ( void )

privateslot

Turn all Archive Check boxes off in List table.

Definition at line 576 of file projectlistmanager.cpp.

{
    SetCheckState(ARCHIVE_BUTTON_COLUMN,false);
}

References ARCHIVE_BUTTON_COLUMN, and SetCheckState().

Referenced by ProjectListManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PressedArchiveOn

void ProjectListManager::PressedArchiveOn ( void )

privateslot

Turn all Archive Check boxes on in List table.

Definition at line 571 of file projectlistmanager.cpp.

{
     SetCheckState(ARCHIVE_BUTTON_COLUMN, true);
}

References ARCHIVE_BUTTON_COLUMN, and SetCheckState().

Referenced by ProjectListManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PressedInstallOff

void ProjectListManager::PressedInstallOff ( void )

privateslot

Turn all Install Check boxes off in List table.

Definition at line 565 of file projectlistmanager.cpp.

{
    SetCheckState(INSTALL_BUTTON_COLUMN,false);
 
}

References INSTALL_BUTTON_COLUMN, and SetCheckState().

Referenced by ProjectListManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PressedInstallOn

void ProjectListManager::PressedInstallOn ( void )

privateslot

Turn all Install Check boxes on in List table.

Definition at line 560 of file projectlistmanager.cpp.

{
    SetCheckState(INSTALL_BUTTON_COLUMN, true);
}

References INSTALL_BUTTON_COLUMN, and SetCheckState().

Referenced by ProjectListManager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessFullList

void ProjectListManager::ProcessFullList ( void )

slot

Add all Projects for Documentation Creation.

Definition at line 264 of file projectlistmanager.cpp.

{
    int row_count = ui->ProjectTableWidget->rowCount();
    for ( int index = 0; (index < row_count) && ( ui->ProjectTableWidget->item( index, 0 ) != nullptr)  ; ++index )
    {
        if ( ( ui->ProjectTableWidget->item( index, 0 ) != nullptr) && ( ui->ProjectTableWidget->item( index, 0 )->text() != "") )
        {
            doxy_manager->ProcessProject(ProjectList[index]);
        }
    }
}

References doxy_manager, ProjectList, and ui.

◆ ProcessSelection

void ProjectListManager::ProcessSelection ( void )

slot

Add th Selected Project for Documentation Creation.

Definition at line 227 of file projectlistmanager.cpp.

{
    int index = ui->ProjectTableWidget->currentRow();
    if ((index > 1) && (ui->ProjectTableWidget->item (index, 0) != nullptr)
        && (ui->ProjectTableWidget->item (index, 0)->text () != ""))
      {
        ProjectList[index]->ProjectDesc.ProjectSelections = FindSelections(index);
        doxy_manager->ProcessProject (ProjectList[index]);
    }
}

References doxy_manager, FindSelections(), ProjectList, and ui.

Here is the call graph for this function:

◆ ProjectTabChanged

void ProjectListManager::ProjectTabChanged ( int Index )

slot

Process the Change in Window Tab.

Parameters

Selected Window Tab Index

Definition at line 57 of file projectlistmanager.cpp.

{
    QString list_table_string;
 
    switch( Index )
    {
        case CREATE_UPDATE_TAB:
        break;
 
        case UPDATE_PROJECTS_TAB:
            InitaliseProjectTable();
            list_table_string = MakeHTMLProjectPage(ui->ProjectListHeaderFile->text(), ui->ProjectListFooterFile->text(), ui->ProjectListLineFile->text(), true);
            WriteTextFile(ui->PrimaryWebsiteDirectory->text() + "/projects/" + ui->ProjectListWebTableFile->text(), list_table_string);
            list_table_string = MakeOSProjectPage();
            WriteTextFile(ui->PrimaryWebsiteDirectory->text() + "/projects/" + ui->ProjectOSListName->text(), list_table_string);
        break;
 
        case PROGRAM_SETUP_TAB:
        break;
 
        case LOG_TAB:
        break;
 
        case LICENCE_ACK_TAB:
        break;
    }
}

References CREATE_UPDATE_TAB, InitaliseProjectTable(), LICENCE_ACK_TAB, LOG_TAB, MakeHTMLProjectPage(), MakeOSProjectPage(), PROGRAM_SETUP_TAB, ui, UPDATE_PROJECTS_TAB, and WriteTextFile().

Here is the call graph for this function:

◆ PrStateChange

void ProjectListManager::PrStateChange ( PROJECT_INFORMATION * Project )

slot

Update the Lock/Queued Status of Project in the Project List Table.

Parameters

Project POinter to Project's Information

Definition at line 532 of file projectlistmanager.cpp.

{
    // Find the Line with this Project Ident
    QList<QTableWidgetItem *> item_list = ui->ProjectTableWidget->findItems (
        Project->ProjectDesc.ProjectIdent, Qt::MatchExactly);
    if (item_list.count () != 1)
      {
        LogAdd (LOG_ERROR, MODE_QT,
                QString ("Error Finding Project %1 in the Table Widget. ")
                    .arg (Project->ProjectDesc.ProjectIdent));
      }
    else
      {
        if (!Project->ProjectLock)
          {
            item_list[0]->setForeground (QBrush (QColor (INACTIVE_COLOUR)));
          }
        else
          {
            if (Project->ProjectQueued)
              item_list[0]->setForeground (QBrush (QColor (QUEUED_COLOUR)));
            else
              item_list[0]->setForeground (QBrush (QColor (LOCK_COLOUR)));
          }
        ui->ProjectTableWidget->repaint ();
      }
}

References INACTIVE_COLOUR, LOCK_COLOUR, LOG_ERROR, LogAdd(), MODE_QT, PROJECT_INFORMATION::ProjectDesc, PROJECT_DESCRIPTION::ProjectIdent, PROJECT_INFORMATION::ProjectLock, PROJECT_INFORMATION::ProjectQueued, QUEUED_COLOUR, and ui.

Referenced by LoadProjectTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadTableTemplate()

QString ProjectListManager::ReadTableTemplate ( QString TemplateFile )

private

Read an HTML template from a File.

Parameters

TemplateFile Name of the Template File

Returns: The contents of the Template as a String

Definition at line 498 of file projectlistmanager.cpp.

{
    QString text_result;
    QFile file(TemplateFile);
    if (file.open(QIODevice::ReadOnly | QIODevice::Text))
    {
        QTextStream in(&file);
        while(!in.atEnd())
        {
            text_result += in.readLine();
        }
    }
    return(text_result);
}

Referenced by MakeHTMLProjectPage().

Here is the caller graph for this function:

◆ SendLogEntry

void ProjectListManager::SendLogEntry ( REMOTE_LOG_ENTRY log_entry )

signal

Referenced by LogAdd().

Here is the caller graph for this function:

◆ SetCheckState()

void ProjectListManager::SetCheckState	(	int	column,
		bool	InstallState )

private

Set the State of all Project Selection in Table List.

Parameters

Colum	of Project List Table
InstallState	State (Off/On) to be Install in all Switches

Definition at line 581 of file projectlistmanager.cpp.

{
    int row_count = ui->ProjectTableWidget->rowCount();
    for (int row = 0; row < row_count; row++)
    {
        QCheckBox* checkBox = nullptr;
 
        if (QWidget* w = ui->ProjectTableWidget->cellWidget(row, column))
        {
            if (QLayout* layout = w->layout())
            {
                if (QLayoutItem* layoutItem = layout->itemAt(0))
                {
                    if (QWidgetItem* widgetItem = dynamic_cast<QWidgetItem*>(layoutItem))
                    {
                        checkBox = qobject_cast<QCheckBox*>(widgetItem->widget());
                        checkBox->setChecked(CheckState);
                    }
                }
            }
        }
    }
}

References ui.

Referenced by PressedArchiveOff(), PressedArchiveOn(), PressedInstallOff(), and PressedInstallOn().

Here is the caller graph for this function:

◆ SetMaximumProjects()

void ProjectListManager::SetMaximumProjects ( void )

private

Set the Initial Line Count in the Project List table.

Definition at line 212 of file projectlistmanager.cpp.

{
    int current_row_count = ui->ProjectTableWidget->rowCount();
    int project_count = 0;
 
    QString count_query = "select count(*) from project";
    QSqlQuery project_counter(count_query);
    while (project_counter.next())
    {
        project_count = project_counter.value(0).toInt();
    }
    int increased_project_count = project_count - 1;
    if (current_row_count < increased_project_count) ui->ProjectTableWidget->setRowCount(increased_project_count);
}

References ui.

Referenced by LoadProjectTable(), and ProjectListManager().

Here is the caller graph for this function:

◆ WriteTextFile()

bool ProjectListManager::WriteTextFile	(	QString	FileName,
		QString	Contents )

private

Write a String to a File.

Parameters

FileName	The name of the Target File
Contents	The String to be written to the File

Returns: Success (true) or Failure (false)

Definition at line 513 of file projectlistmanager.cpp.

{
    bool result = false;
    QFile file(FileName);
    if (file.open(QIODevice::WriteOnly | QIODevice::Text))
    {
        QTextStream out(&file);
        out << Contents;
        result = true;
        LogAdd(LOG_DEBUG, MODE_FILE, QString("Wrote Project List File %1 ").arg(FileName));
    }
    else
    {
        LogAdd(LOG_ERROR, MODE_FILE, QString("Unable to write Project List File %1 ").arg(FileName));
 
    }
    return(result);
}

References LOG_DEBUG, LOG_ERROR, LogAdd(), and MODE_FILE.

Referenced by ProjectTabChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ base_project_query

QString ProjectListManager::base_project_query

private

Basic SQL Query for listing Projects.

Definition at line 170 of file projectlistmanager.h.

Referenced by LoadProjectTable(), MakeHTMLProjectPage(), MakeOSProjectPage(), and ProjectListManager().

◆ ProjectList

QList<PROJECT_INFORMATION*> ProjectListManager::ProjectList

private

A list of Projects to be processed.

Definition at line 176 of file projectlistmanager.h.

Referenced by LoadProjectTable(), ProcessFullList(), ProcessSelection(), and ProjectListManager().

◆ sort_group

QButtonGroup* ProjectListManager::sort_group

private

Pointer to Button Group for sorting Project List Table.

Definition at line 164 of file projectlistmanager.h.

◆ ui

Ui::MainWindow* ProjectListManager::ui

private

brief Pointer to the main window

Definition at line 158 of file projectlistmanager.h.

Referenced by FindSelections(), LoadProjectTable(), MakeHTMLProjectPage(), MakeOSProjectPage(), ProcessFullList(), ProcessSelection(), ProjectListManager(), ProjectTabChanged(), PrStateChange(), SetCheckState(), and SetMaximumProjects().

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

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProjectListManager()

◆ ~ProjectListManager()

Member Function Documentation

◆ FindSelections()

◆ InitaliseProjectTable()

◆ LoadProjectTable

◆ LogAdd()

◆ MakeHTMLProjectPage()

◆ MakeOSProjectPage()

◆ PressedArchiveOff

◆ PressedArchiveOn

◆ PressedInstallOff

◆ PressedInstallOn

◆ ProcessFullList

◆ ProcessSelection

◆ ProjectTabChanged

◆ PrStateChange

◆ ReadTableTemplate()

◆ SendLogEntry

◆ SetCheckState()

◆ SetMaximumProjects()

◆ WriteTextFile()

Field Documentation

◆ base_project_query

◆ ProjectList

◆ sort_group

◆ ui