Project Documentation Manager BRIGADOON-0002
Project Documentation Manager
Loading...
Searching...
No Matches
projectsubstitute.h File Reference

Class Controlling Text Substitution. More...

#include <QObject>
#include "logger.h"
#include "projectoptionsmanager.h"
Include dependency graph for projectsubstitute.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  ProjectSubstitute

Macros

#define DEFAULT_RETURN_ADDRESS   "https://www.little.id.au/projects/index.php"
 Default Return Address inserted into Project.
#define MAXIMUM_KEY_VALUE_PAIRS   60
 Define the Maximum number of Key-Value pairs to Display.
#define PROJECT_KEY_COLUMN_WIDTH   150
 Define the Key's Column Width in the display.

Enumerations

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 , PROJECT_ITEM_END
}
 A sequential list of Project Parameters. More...

Detailed Description

Class Controlling Text Substitution.

Definition in file projectsubstitute.h.

Macro Definition Documentation

◆ DEFAULT_RETURN_ADDRESS

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

Default Return Address inserted into Project.

Definition at line 20 of file projectsubstitute.h.

◆ MAXIMUM_KEY_VALUE_PAIRS

#define MAXIMUM_KEY_VALUE_PAIRS   60

Define the Maximum number of Key-Value pairs to Display.

Definition at line 68 of file projectsubstitute.h.

Referenced by ProjectSubstitute::ProjectSubstitute().

◆ PROJECT_KEY_COLUMN_WIDTH

#define PROJECT_KEY_COLUMN_WIDTH   150

Define the Key's Column Width in the display.

Definition at line 74 of file projectsubstitute.h.

Referenced by ProjectSubstitute::ProjectSubstitute().

Enumeration Type Documentation

◆ PROJECT_ITEM

A sequential list of Project Parameters.

Enumerator
PROJECT_NAME 

Project Name Index

PROJECT_IDENT 

Project Identification Index

MAJOR_VERSION 

Project Major FVersion index

MINOR_VERSION 

Project Minor Version Index

REVISION 

Project Revision Index

BRIEF_DESCRIPTION 

Project Brief Description Index

DEV_FAMILY 

Project Development Family Index

LANGUAGE_FAMILY 

Project Compiler Language Family Index

PRIMARY_TOOL 

Project Primary Development Tool Index

SYSTEM_FAMILY 

Project Target System Family Index

PROJECT_STATUS 

Project Development Status Index

PROJECT_HISTORY 

Project Full Development History Index

STATUS_DATE 

Project Status Date index

DOCUMENT_LICENCE 

Project Documentation Licence Index

SOFTWARE_LICENCE 

Project Software Licence Index

HARDWARE_LICENCE 

Project Hardware Licence Incex

PROJECT_CONTACT 

Project Contact Person Index

PROJECT_EMAIL 

Project Contact Email Address Index

FULL_DESCRIPTION 

Project Full Description Index

PROJECT_DIRECTORY 

Project Development Directory Index

PROJECT_ICON 

Project Icon Filename Index

DOXY_LOGO 

Project Doxygen Logo Filename Index

DOXY_HTML_HEADER 

Project Doxygen Header Filename Index

DOXY_HTML_FOOTER 

Project Doxygen Footer Filename Index

DOXY_EXTRA_STYLESHEET 

Project Doxygen extra Stylesheet Index

ASSOCIATED_GROUP 

Project Associated Group Index

DEPARTURE_URL 

Project Exit URL Index

SITE_URL 

Site holding the Project web pages

EXECUTABLE_DIR 

Project Directory where Exe is compiled

SOURCE_LIST 

List of Source & Other Significant Files

PROJECT_ITEM_END 

Value that says hoe many items in list

Definition at line 27 of file projectsubstitute.h.

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