Warning, /education/marble/Mainpage.dox is written in an unsupported language. File is not indexed.

0001 /** @mainpage Marble 
0003 Marble is an application that displays a view of the earth.  It is
0004 both a valuable application in its own right, but also an example
0005 program that shows how you can use the Marble widgets in your own
0006 applications. 
0008 We have designed Marble so that you can use its components easily to
0009 enhance your application with geo services. This manual enumerates the
0010 components and describes how to use them in your own application.
0012 The Marble application makes use of the following classes and widgets:
0014 1. MarbleWidget, the main widget in any application using the Marble
0015    framework.  This widget displays a view of the earth or any other
0016    globe, depending on which dataset is used.  The user can navigate
0017    the globe using either a control widget, e.g. the MarbleNavigator,
0018    or the mouse.  
0020 2. MarbleModel, the data storage class that holds the data that is
0021    visualized in the MarbleWidget. The MarbleModel is created internally
0022    and can be accessed using the model() method.
0024    This data model contains several separate datatypes, among them:
0025    <b>tiles</b> which provide the background map, <b>vectors</b> which
0026    provide things like country borders and coastlines and <b>placemarks</b>
0027    which can show points of interest, such as cities, mountain tops or the poles.
0029 These two classes provide the core of the classes that comprise the
0030 Marble framework.  You can use only them and get a very capable
0031 application.
0033 In addition to this, there is also a simple control widget called the
0034 MarbleNavigator that controls panning and zooming. This control widget
0035 can be used in simpler application where theming, searching and other
0036 advanced controls are not needed.
0038 To help you get started, we provide small example programs which you can
0039 find in the examples/cpp directory of the sources. They are also available
0040 online at <a href="http://techbase.kde.org/Projects/Marble/MarbleCPlusPlus">KDE TechBase</a>.
0042 @see Marble::MarbleWidget
0043 @see Marble::MarbleModel
0044 @see Marble::MarbleNavigator
0045 @see <a href="http://techbase.kde.org/Projects/Marble/MarbleCPlusPlus">KDE TechBase: MarbleCPlusPlus</a>
0047  */