Difference between revisions of "Branding"

From FreeCAD Documentation
Jump to: navigation, search
(Program Name: Qt-License)
m ([[ | ]])
 
(37 intermediate revisions by 13 users not shown)
Line 1: Line 1:
This article describes the '''Branding''' of FreeCAD. That is how to give FreeCAD a unique look.
+
<languages/>
 +
<translate>
 +
<!--T:11-->
 +
{{docnav
 +
|[[Continuous Integration|Continuous Integration]]
 +
|[[Localisation|Localisation]]
 +
}}
  
== General ==
+
<!--T:1-->
Most of the branding is done in the [[FreeCADMain]] module. In the file ''MainGui.cpp'' the most important settings for a new look can be made in one place. Here is the code section that controls the branding:
+
This article describes the '''Branding''' of FreeCAD. Branding means to start your own application on base of FreeCAD. That can be only your own executable or [[Splash screen|splash screen]] till a complete reworked program. On base of the flexible architecture of FreeCAD it's easy to use it as base for your own special purpose program.
  
'''1'''  // Name and Version of the Application
+
=== General === <!--T:2-->
'''2'''  App::Application::Config()["ExeName"] = "FreeCAD";
+
Most of the branding is done in the {{FileName|MainCmd.cpp}} or {{FileName|MainGui.cpp}}. These Projects generate the executable files of FreeCAD. To make your own Brand just copy the Main or MainGui projects and give the executable an own name, e.g. {{FileName|FooApp.exe}}.
'''3'''
+
The most important settings for a new look can be made in one place in the main() function. Here is the code section that controls the branding:
'''4'''  // set the banner (for logging and console)
 
'''5'''  App::Application::Config()["ConsoleBanner"] = sBanner;
 
'''6'''  App::Application::Config()["AppIcon"] = "FCIcon";
 
'''7'''  App::Application::Config()["SplashPicture"] = "FreeCADSplasher";
 
  
The first command in line 2 defines the Programm name. This is not the executable name, which can be changed by renaming or by compiler settings, but the name that is displayed in the taskbar on windows or in the program list on unix systems.
+
</translate>
 +
<!-- WARNING Do not modify the <syntaxhighligh> tag because of "{}" or pipe characters "|" included in the source code of the macro -->
 +
<syntaxhighlight>
 +
int main( int argc, char ** argv )
 +
{
 +
  // Name and Version of the Application
 +
  App::Application::Config()["ExeName"] = "FooApp";
 +
  App::Application::Config()["ExeVersion"] = "0.7";
 +
 +
  // set the banner (for loging and console)
 +
  App::Application::Config()["CopyrightInfo"] = sBanner;
 +
  App::Application::Config()["AppIcon"] = "FooAppIcon";
 +
  App::Application::Config()["SplashScreen"] = "FooAppSplasher";
 +
  App::Application::Config()["StartWorkbench"] = "Part design";
 +
  App::Application::Config()["HiddenDockWindow"] = "Property editor";
 +
  App::Application::Config()["SplashAlignment" ] = "Bottom|Left";
 +
  App::Application::Config()["SplashTextColor" ] = "#000000"; // black
 +
 +
  // Inits the Application
 +
  App::Application::Config()["RunMode"] = "Gui";
 +
  App::Application::init(argc,argv);
 +
 +
  Gui::BitmapFactory().addXPM("FooAppSplasher", ( const char** ) splash_screen);
 +
 +
  Gui::Application::initApplication();
 +
  Gui::Application::runApplication();
 +
  App::Application::destruct();
 +
 +
  return 0;
 +
}
 +
</syntaxhighlight>
 +
<translate>
  
Line 5 defines a text string that contains the console banner that is shown on startup. Lines 6 and 7 define the program icon image and the [[splash screen]] image.
+
<!--T:3-->
 +
The first Config entry defines the program name. This is not the executable name, which can be changed by renaming or by compiler settings, but the name that is displayed in the task bar on windows or in the program list on Unix systems.
  
== Program Name ==
+
<!--T:4-->
To change the program name, just change the string for the config setting of "ExeName" in ''MainGui.cpp''. Et voila, you just made your first step in creating an own brand based on FreeCAD.
+
The next lines define the Config entries of your FooApp Application. A description of the Config and its entries you find in [[Start up and Configuration]].
  
If you wonder about the <nowiki>"[Non-Commercial]"</nowiki> text in the window title this is due to the missing licence for [[wikipedia:Qt (toolkit)|Qt]]. See the [[Licence]] article for more info on that.
+
=== Images === <!--T:5-->
 +
Image resources are compiled into FreeCAD using [http://qt-project.org/doc/qt-4.8/resources.html Qt's resource system]. Therefore you have to write a {{FileName|.qrc}} file, an XML-based file format that lists image files on the disk but also any other kind of resource files. To load the compiled resources inside the application you have to add a line
  
== Images ==
+
</translate>
All image resources are compiled into FreeCAD. This reduces delayed loading and keeps the installation compact. The images are included in XPM-Format which is basically a text format that uses C-syntax. You can basically draw this images with a text editor, but it is more comfortable to create the images with your favorite graphics program and convert it later to XPM format.
+
{{Code|code=
 +
Q_INIT_RESOURCE(FooApp);
 +
}}
 +
<translate>
  
For conversion you can use the ''[[ImageConv]]'' tool wich is included with freecad. You can find it under
+
<!--T:6-->
 +
into the main() function. Alternatively, if you have an image in XPM format you can directly include it into your {{FileName|main.cpp}} and add the following line to register it:
  
  /trunk/src/Tools/ImageTools/ImageConv
+
</translate>
 +
{{Code|code=
 +
  Gui::BitmapFactory().addXPM("FooAppSplasher", ( const char** ) splash_screen);
 +
}}
 +
<translate>
  
It can not only convert images but also automatically update the ''BmpFactoryIcons.cpp'' file, where the images are registered. The typical usage is as simple like the following example:
+
=== Branding XML === <!--T:7-->
 +
In FreeCAD there is also a method supported without writing a customized main() function. For this method you must write a file name called {{FileName|branding.xml}} and put it into the installation directory of FreeCAD. Here is an example with all supported tags:
  
  ImageConv -i InputImage.png -o OutputImage.xpm
+
</translate>
 +
<!-- WARNING Do not modify the <syntaxhighligh> tag because of "{}" or pipe characters "|" included in the source code of the macro -->
 +
<syntaxhighlight>
 +
  <?xml version="1.0" encoding="utf-8"?>
 +
<Branding>
 +
<Application>FooApp</Application>
 +
<WindowTitle>Foo App in title bar</WindowTitle>
 +
<BuildVersionMajor>1</BuildVersionMajor>
 +
<BuildVersionMinor>0</BuildVersionMinor>
 +
<BuildRevision>1234</BuildRevision>
 +
<BuildRevisionDate>2014/1/1</BuildRevisionDate>
 +
<CopyrightInfo>(c) My copyright</CopyrightInfo>
 +
<MaintainerUrl>Foo App URL</MaintainerUrl>
 +
<ProgramLogo>Path to logo (appears in bottom right corner)</ProgramLogo>
 +
<WindowIcon>Path to icon file</WindowIcon>
 +
<ProgramIcons>Path to program icons</ProgramIcons>
 +
<SplashScreen>splashscreen.png</SplashScreen>
 +
<SplashAlignment>Bottom|Left</SplashAlignment>
 +
<SplashTextColor>#ffffff</SplashTextColor>
 +
<SplashInfoColor>#c8c8c8</SplashInfoColor>
 +
<StartWorkbench>PartDesignWorkbench</StartWorkbench>
 +
</Branding>
 +
</syntaxhighlight>
 +
<translate>
  
This converts the file ''InputImage.png'' in XPM-format and writes the result to file ''OutputImage.xpm''.
+
<!--T:8-->
 +
All of the listed tags are optional.
  
=== Icons ===
+
<!--T:9-->
The main application icon ''FCIcon'' that appears in window titles and other places is defined in
+
{{docnav
 +
|[[Continuous Integration|Continuous Integration]]
 +
|[[Localisation|Localisation]]
 +
}}
  
/trunk/src/Gui/Icons/images.cpp
+
<!--T:12-->
 +
{{Userdocnavi}}
  
and starts with the line
+
<!--T:10-->
 
+
[[Category:Developer Documentation]]
<nowiki>static const char *FCIcon[]={</nowiki>
+
</translate>
 
+
{{clear}}
Replace it with your favourite icon, recompile freecad and the next step to create your own brand is done. There are many other icons in this file that you might change to your gusto.
 
 
 
If you need to add new icons, you have to register it in
 
/trunk/src/Gui/Icons/BmpFactoryIcons.cpp
 
so that you can access from FreeCAD.
 
 
 
=== Splash Screen ===
 
The [[splash screen]] image, that is also used as background for the ''About Box'' is located in the file
 
/trunk/src/Gui/Icons/developers.h
 
and starts with the line
 
<nowiki>static const char* const splash_screen[] = {</nowiki>
 
Replace the contents of this static array with an XPM image of your choice to make FreeCAD looking more how you like it.
 
 
 
=== Background Image ===
 
The background image appears, when no document window is open. Like the splash screen it is defined in ''developers.h'' in the section starting with:
 
static const char* const background[]={
 
You should choose a low contrast image for the background. Otherwise it might irritate the user.
 
 
 
[[Category:Developer]]
 

Latest revision as of 11:15, 4 November 2019

Other languages:
čeština • ‎Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎română • ‎русский • ‎svenska • ‎Türkçe

This article describes the Branding of FreeCAD. Branding means to start your own application on base of FreeCAD. That can be only your own executable or splash screen till a complete reworked program. On base of the flexible architecture of FreeCAD it's easy to use it as base for your own special purpose program.

General

Most of the branding is done in the MainCmd.cpp or MainGui.cpp. These Projects generate the executable files of FreeCAD. To make your own Brand just copy the Main or MainGui projects and give the executable an own name, e.g. FooApp.exe. The most important settings for a new look can be made in one place in the main() function. Here is the code section that controls the branding:

 int main( int argc, char ** argv )
 {
   // Name and Version of the Application
   App::Application::Config()["ExeName"] = "FooApp";
   App::Application::Config()["ExeVersion"] = "0.7";
 
   // set the banner (for loging and console)
   App::Application::Config()["CopyrightInfo"] = sBanner;
   App::Application::Config()["AppIcon"] = "FooAppIcon";
   App::Application::Config()["SplashScreen"] = "FooAppSplasher";
   App::Application::Config()["StartWorkbench"] = "Part design";
   App::Application::Config()["HiddenDockWindow"] = "Property editor";
   App::Application::Config()["SplashAlignment" ] = "Bottom|Left";
   App::Application::Config()["SplashTextColor" ] = "#000000"; // black
 
   // Inits the Application 
   App::Application::Config()["RunMode"] = "Gui";
   App::Application::init(argc,argv);
 
   Gui::BitmapFactory().addXPM("FooAppSplasher", ( const char** ) splash_screen);
 
   Gui::Application::initApplication();
   Gui::Application::runApplication();
   App::Application::destruct();
 
   return 0;
 }

The first Config entry defines the program name. This is not the executable name, which can be changed by renaming or by compiler settings, but the name that is displayed in the task bar on windows or in the program list on Unix systems.

The next lines define the Config entries of your FooApp Application. A description of the Config and its entries you find in Start up and Configuration.

Images

Image resources are compiled into FreeCAD using Qt's resource system. Therefore you have to write a .qrc file, an XML-based file format that lists image files on the disk but also any other kind of resource files. To load the compiled resources inside the application you have to add a line

Q_INIT_RESOURCE(FooApp);

into the main() function. Alternatively, if you have an image in XPM format you can directly include it into your main.cpp and add the following line to register it:

Gui::BitmapFactory().addXPM("FooAppSplasher", ( const char** ) splash_screen);

Branding XML

In FreeCAD there is also a method supported without writing a customized main() function. For this method you must write a file name called branding.xml and put it into the installation directory of FreeCAD. Here is an example with all supported tags:

 <?xml version="1.0" encoding="utf-8"?>
 <Branding>
 	<Application>FooApp</Application>
 	<WindowTitle>Foo App in title bar</WindowTitle>
 	<BuildVersionMajor>1</BuildVersionMajor>
 	<BuildVersionMinor>0</BuildVersionMinor>
 	<BuildRevision>1234</BuildRevision>
 	<BuildRevisionDate>2014/1/1</BuildRevisionDate>
 	<CopyrightInfo>(c) My copyright</CopyrightInfo>
 	<MaintainerUrl>Foo App URL</MaintainerUrl>
 	<ProgramLogo>Path to logo (appears in bottom right corner)</ProgramLogo>
 	<WindowIcon>Path to icon file</WindowIcon>
 	<ProgramIcons>Path to program icons</ProgramIcons>
 	<SplashScreen>splashscreen.png</SplashScreen>
 	<SplashAlignment>Bottom|Left</SplashAlignment>
 	<SplashTextColor>#ffffff</SplashTextColor>
 	<SplashInfoColor>#c8c8c8</SplashInfoColor>
 	<StartWorkbench>PartDesignWorkbench</StartWorkbench>
 </Branding>

All of the listed tags are optional.