Branding/sv: Difference between revisions

From FreeCAD Documentation
(Created page with "{{docnav/sv|Testing/sv|Localisation/sv}}")
(Updating to match new version of source page)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>

{{Docnav
|[[Continuous_Integration|Continuous Integration]]
|[[Localisation|Localisation]]
}}

{{TOCright}}

==Overview==

<div class="mw-translate-fuzzy">
Denna artikel diskuterar '''Branding''' av FreeCAD. Branding innebär att du gör din egen applikation med FreeCAD som bas. Det kan sträcka sig från att bara ha en egen startfil eller uppstartsbild till ett helt och hållet omarbetat program. På basis FreeCAD's flexibla arkitektur så är det lätt att använda den som bas för dina egna program för speciella ändmål.
Denna artikel diskuterar '''Branding''' av FreeCAD. Branding innebär att du gör din egen applikation med FreeCAD som bas. Det kan sträcka sig från att bara ha en egen startfil eller uppstartsbild till ett helt och hållet omarbetat program. På basis FreeCAD's flexibla arkitektur så är det lätt att använda den som bas för dina egna program för speciella ändmål.
</div>

== Warning ==

Although FreeCAD is offered to you free of charge, and the FreeCAD community is happy to see other applications emerging, that are based on FreeCAD, we have on the other hand seen a lot of unfair use of the information contained on this page by people who simply rebranded FreeCAD into a closed-source application to make profit from it.

Although the [[License|LGPL license]] allows to use the FreeCAD source code in closed-source applications, it also gives strict rules to do so, and does not allow simply taking FreeCAD, renaming it and stripping it of its license.

Would you be interested in using FreeCAD in a closed-source application, be sure to check thoroughly the implications of the LGPL license, and, even better, contact any FreeCAD developer, administrator or moderator before doing so.

== General ==


<div class="mw-translate-fuzzy">
=== Allmänt ===
=== Allmänt ===
Den mesta brandingen görs i '''MainCmd.cpp'' or ''MainGui.cpp'''. Dessa Projekt genererar FreeCAD's körbara filer. För att göra din egen variant så behöver du bara kopiera Main eller MainGui projekten och ge den körbara filen ett eget namn, d.v.s. FooApp.exe.
Den mesta brandingen görs i '''MainCmd.cpp'' or ''MainGui.cpp'''. Dessa Projekt genererar FreeCAD's körbara filer. För att göra din egen variant så behöver du bara kopiera Main eller MainGui projekten och ge den körbara filen ett eget namn, d.v.s. FooApp.exe.


De viktigaste inställningarna för ett nytt utseende kan göras på en plats i main() funktionen. Här är den kodsektion som kontrollerar branding:
De viktigaste inställningarna för ett nytt utseende kan göras på en plats i main() funktionen. Här är den kodsektion som kontrollerar branding:
</div>


<!-- WARNING Do not modify the <syntaxhighligh> tag because of "{}" or pipe characters "|" included in the source code of the macro -->
<syntaxhighlight>
<syntaxhighlight lang="C">
int main( int argc, char ** argv )
int main( int argc, char ** argv )
{
{
// Name and Version of the Application
// Name and Version of the Application
App::Application::Config()["ExeName"] = "FooApp";
App::Application::Config()["ExeVersion"] = "0.7";
App::Application::Config()["ExeName"] = "FooApp";
App::Application::Config()["ExeVersion"] = "0.7";

// set the banner (for loging and console)
// set the banner (for loging and console)
App::Application::Config()["CopyrightInfo"] = sBanner;
App::Application::Config()["AppIcon"] = "FooAppIcon";
App::Application::Config()["CopyrightInfo"] = sBanner;
App::Application::Config()["SplashScreen"] = "FooAppSplasher";
App::Application::Config()["AppIcon"] = "FooAppIcon";
App::Application::Config()["StartWorkbench"] = "Part design";
App::Application::Config()["SplashScreen"] = "FooAppSplasher";
App::Application::Config()["HiddenDockWindow"] = "Property editor";
App::Application::Config()["StartWorkbench"] = "Part design";
App::Application::Config()["SplashAlignment" ] = "Bottom|Left";
App::Application::Config()["HiddenDockWindow"] = "Property editor";
App::Application::Config()["SplashTextColor" ] = "#000000"; // black
App::Application::Config()["SplashAlignment" ] = "Bottom|Left";
App::Application::Config()["SplashTextColor" ] = "#000000"; // black

// Inits the Application
// Inits the Application
App::Application::Config()["RunMode"] = "Gui";
App::Application::init(argc,argv);
App::Application::Config()["RunMode"] = "Gui";
App::Application::init(argc,argv);

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

Gui::Application::initApplication();
Gui::Application::runApplication();
Gui::Application::initApplication();
App::Application::destruct();
Gui::Application::runApplication();
App::Application::destruct();

return 0;
return 0;
}
}
</syntaxhighlight>
</syntaxhighlight>

Den första Config punkten definierar programmets namn. Detta är inte det körbara namnet, vilket kan ändras genom att döpa om eller genom inställningar i kompilatorn, utan det namn som visas i windows programrad eller i programlistan på Unixsystem.
Den första Config punkten definierar programmets namn. Detta är inte det körbara namnet, vilket kan ändras genom att döpa om eller genom inställningar i kompilatorn, utan det namn som visas i windows programrad eller i programlistan på Unixsystem.


Efterföljande rader definierar Config punkterna för din FooApp Applikation. En beskrivning av Config och dess punkter hittar du i [[Start up and Configuration/sv|Uppstart och Konfiguration]].
Efterföljande rader definierar Config punkterna för din FooApp Applikation. En beskrivning av Config och dess punkter hittar du i [[Start up and Configuration/sv|Uppstart och Konfiguration]].


=== Images ===
== Images ==

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 .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
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
<syntaxhighlight>

Q_INIT_RESOURCE(FooApp);
{{Code|code=
</syntaxhighlight>
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:
}}
<syntaxhighlight>

Gui::BitmapFactory().addXPM("FooAppSplasher", ( const char** ) splash_screen);
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:
</syntaxhighlight>

=== Branding XML ===
{{Code|code=
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:
Gui::BitmapFactory().addXPM("FooAppSplasher", ( const char** ) splash_screen);
<syntaxhighlight>
}}
<?xml version="1.0" encoding="utf-8"?>

<Branding>
== Branding XML ==
<Application>FooApp</Application>

<WindowTitle>Foo App in title bar</WindowTitle>
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:
<BuildVersionMajor>1</BuildVersionMajor>

<BuildVersionMinor>0</BuildVersionMinor>
<!-- WARNING Do not modify the <syntaxhighligh> tag because of "{}" or pipe characters "|" included in the source code of the macro -->
<BuildRevision>1234</BuildRevision>
<syntaxhighlight lang="XML">
<BuildRevisionDate>2014/1/1</BuildRevisionDate>
<?xml version="1.0" encoding="utf-8"?>
<CopyrightInfo>(c) My copyright</CopyrightInfo>
<Branding>
<MaintainerUrl>Foo App URL</MaintainerUrl>
<Application>FooApp</Application>
<ProgramLogo>Path to logo (appears in bottom right corner)</ProgramLogo>
<WindowTitle>Foo App in title bar</WindowTitle>
<WindowIcon>Path to icon file</WindowIcon>
<BuildVersionMajor>1</BuildVersionMajor>
<ProgramIcons>Path to program icons</ProgramIcons>
<BuildVersionMinor>0</BuildVersionMinor>
<SplashScreen>splashscreen.png</SplashScreen>
<BuildRevision>1234</BuildRevision>
<SplashAlignment>Bottom|Left</SplashAlignment>
<BuildRevisionDate>2014/1/1</BuildRevisionDate>
<SplashTextColor>#ffffff</SplashTextColor>
<CopyrightInfo>(c) My copyright</CopyrightInfo>
<SplashInfoColor>#c8c8c8</SplashInfoColor>
<MaintainerUrl>Foo App URL</MaintainerUrl>
<StartWorkbench>PartDesignWorkbench</StartWorkbench>
<ProgramLogo>Path to logo (appears in bottom right corner)</ProgramLogo>
</Branding>
<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>
</syntaxhighlight>
All of the listed tags are optional.


All listed tags are optional.


<div class="mw-translate-fuzzy">
{{docnav/sv|Testing/sv|Localisation/sv}}
{{docnav/sv|Testing/sv|Localisation/sv}}
</div>


{{Userdocnavi{{#translation:}}}}
[[Category:Developer Documentation]]
[[Category:Developer Documentation{{#translation:}}]]
{{clear}}
<languages/>

Latest revision as of 09:46, 12 January 2022

Overview

Denna artikel diskuterar Branding av FreeCAD. Branding innebär att du gör din egen applikation med FreeCAD som bas. Det kan sträcka sig från att bara ha en egen startfil eller uppstartsbild till ett helt och hållet omarbetat program. På basis FreeCAD's flexibla arkitektur så är det lätt att använda den som bas för dina egna program för speciella ändmål.

Warning

Although FreeCAD is offered to you free of charge, and the FreeCAD community is happy to see other applications emerging, that are based on FreeCAD, we have on the other hand seen a lot of unfair use of the information contained on this page by people who simply rebranded FreeCAD into a closed-source application to make profit from it.

Although the LGPL license allows to use the FreeCAD source code in closed-source applications, it also gives strict rules to do so, and does not allow simply taking FreeCAD, renaming it and stripping it of its license.

Would you be interested in using FreeCAD in a closed-source application, be sure to check thoroughly the implications of the LGPL license, and, even better, contact any FreeCAD developer, administrator or moderator before doing so.

General

Allmänt

Den mesta brandingen görs i MainCmd.cpp or MainGui.cpp. Dessa Projekt genererar FreeCAD's körbara filer. För att göra din egen variant så behöver du bara kopiera Main eller MainGui projekten och ge den körbara filen ett eget namn, d.v.s. FooApp.exe.

De viktigaste inställningarna för ett nytt utseende kan göras på en plats i main() funktionen. Här är den kodsektion som kontrollerar 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;
}

Den första Config punkten definierar programmets namn. Detta är inte det körbara namnet, vilket kan ändras genom att döpa om eller genom inställningar i kompilatorn, utan det namn som visas i windows programrad eller i programlistan på Unixsystem.

Efterföljande rader definierar Config punkterna för din FooApp Applikation. En beskrivning av Config och dess punkter hittar du i Uppstart och Konfiguration.

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 listed tags are optional.


Testing/sv
Localisation/sv