legal.h File Reference

Include dependency graph for legal.h:

Go to the source code of this file.

Functions
::Factory< uiString > &	legalInformation ()
uiString	gplV3Text ()
	Gnu Public License V3 text. More...
uiString	lgplV3Text ()
	Gnu Lesser Public License Text. Includes GPL text. More...

Function Documentation

gplV3Text()

uiString gplV3Text

(

)

Gnu Public License V3 text.

legalInformation()

::Factory<uiString>& legalInformation

(

)

Code that is reworked from other open source projects is sometimes required to display copyright information as well as discalmers.

Such messages are handled through a factory, where messages can be added. To do so, a static function that returns the message has to be implemented, and given to the factory at startup:

static uiString* legalInfo()
{
    uiString* res = new uiString;
    *res = toUiString(
            "Copyright (C) Myself\n"
            "Full legal info");
    return res;
}
 
MyClass::initClass()
{
    legalInformation().addCreator( legalInfo, "My code" );
}

The text is then visible to users at the Help->Legal menu of OpendTect

lgplV3Text()

uiString lgplV3Text

(

)

Gnu Lesser Public License Text. Includes GPL text.