File: clanapp.h

package info (click to toggle)
clanlib 0.5.4-1-6
  • links: PTS
  • area: main
  • in suites: woody
  • size: 10,320 kB
  • ctags: 10,893
  • sloc: cpp: 76,056; xml: 3,281; sh: 2,961; perl: 1,204; asm: 837; makefile: 775
file content (56 lines) | stat: -rw-r--r-- 1,833 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/*
	$Id: clanapp.h,v 1.10 2001/10/10 17:54:21 japj Exp $

	------------------------------------------------------------------------
	ClanLib, the platform independent game SDK.

	This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
	version 2. See COPYING for details.

	For a total list of contributers see CREDITS.

	See http://www.clanlib.org
	------------------------------------------------------------------------
*/

//! clanApp="System"
//! header=application.h

#ifndef header_clanapp
#define header_clanapp

//: The starting place for all applications.
//- The application class must be inherited by all ClanLib applications.
//- <p>In your application create a class inheriting CL_ClanApplication, 
//- make a global instance of it, and fill in the main() and get_title() functions.</p>
class CL_ClanApplication
{
public:
//! Construction:
	//: Clan Application constructor
	CL_ClanApplication();

	//: Clan Application destructor
	virtual ~CL_ClanApplication();

//! Overrideables:

	//: Every program made using ClanLib must implement this function. 
	//: This is the main application function, which will be called _once_ following system initialization.
	//- argc - The number of arguments to the program (c-style)
	//- argv - A pointer to strings, containing the program arguments. The name of the program executable is always passed as first argument.
	//- returns - Program return value
	virtual int main(int argc, char** argv)=0;

//! Attributes:
	//: Get application (window) title
	//- returns - A character string to be put as the application (window) title (when appropriate, ie. not fullscreen, etc)
	virtual char* get_title()=0;

//! Variables:
	//: Static pointer to an initialized instance of this class.
	//: This is set by the constructor.
	static CL_ClanApplication *app;
};

#endif