MapWizard: move most recently used URL on top of static server history (and make...
[marble:marble.git] / Mainpage.dox
1 /** @mainpage Marble 
2
3 Marble is an application that displays a view of the earth.  It is
4 both a valuable application in its own right, but also an example
5 program that shows how you can use the Marble widgets in your own
6 applications. 
7
8 We have designed Marble so that you can use its components easily to
9 enhance your application with geo services. This manual enumerates the
10 components and describes how to use them in your own application.
11
12 The Marble application makes use of the following classes and widgets:
13
14 1. MarbleWidget, the main widget in any application using the Marble
15    framework.  This widget displays a view of the earth or any other
16    globe, depending on which dataset is used.  The user can navigate
17    the globe using either a control widget, e.g. the MarbleControlBox,
18    or the mouse.  
19
20 2. MarbleModel, the data storage class that holds the data that is
21    visualized in the MarbleWidget.  You can either create a
22    MarbleModel of your own, or let the MarbleWidget create one for
23    you. 
24
25    This data model contains 3 separate datatypes: <b>tiles</b> which
26    provide the background, <b>vectors</b> which provide things like
27    country borders and coastlines and <b>placemarks</b> which can show
28    points of interest, such as cities, mountain tops or the poles.
29
30 3. MarbleControlBox, the most advanced control widget for
31    MarbleWidget. It can be used to navigate around the globe, zoom,
32    search for placemarks like cities, control aspects of the view such
33    as showing water bodies, ice, terrain types, and cities. It can
34    also be used to control which dataset is used to provide the
35    background for the image and the projection (currently globe and
36    flat). 
37
38 These three classes provide the core of the classes that comprise the
39 Marble framework.  You can use only them and get a very capable
40 application if you just provide them with some good datasets.
41
42 In addition to this, there is also a simpler control widget called the
43 MarbleNavigator that only controls panning and zooming. The
44 MarbleNavigator is incorporated into the MarbleControlBox in the first
45 tab.  This control widget can be used in simpler application where
46 theming, searching and other advanced controls are not needed.
47
48 @see Marble::MarbleWidget
49 @see Marble::MarbleModel
50 @see MarbleControlBox
51 @see MarbleNavigator
52
53  */