Commit 8fde5cbb authored by Friedrich W. H. Kossebau's avatar Friedrich W. H. Kossebau
Browse files

Remove left-over mentioning of MarbleControlBox and NavigationWidget

Both classes were removed in 5f9835a5
parent f82e3a66
......@@ -14,7 +14,7 @@ The Marble application makes use of the following classes and widgets:
1. MarbleWidget, the main widget in any application using the Marble
framework. This widget displays a view of the earth or any other
globe, depending on which dataset is used. The user can navigate
the globe using either a control widget, e.g. the MarbleControlBox,
the globe using either a control widget, e.g. the MarbleNavigator,
or the mouse.
2. MarbleModel, the data storage class that holds the data that is
......@@ -26,22 +26,14 @@ The Marble application makes use of the following classes and widgets:
provide things like country borders and coastlines and <b>placemarks</b>
which can show points of interest, such as cities, mountain tops or the poles.
3. MarbleControlBox, the most advanced control widget for
MarbleWidget. It can be used to navigate around the globe, zoom,
search for placemarks like cities, control aspects of the view such
as showing water bodies, ice, terrain types, and cities. It can
also be used to control which dataset is used to provide the
background for the image and the projection.
These three classes provide the core of the classes that comprise the
These two classes provide the core of the classes that comprise the
Marble framework. You can use only them and get a very capable
application.
In addition to this, there is also a simpler control widget called the
MarbleNavigator that only controls panning and zooming. The
MarbleNavigator is incorporated into the MarbleControlBox in the first
tab. This control widget can be used in simpler application where
theming, searching and other advanced controls are not needed.
In addition to this, there is also a simple control widget called the
MarbleNavigator that controls panning and zooming. This control widget
can be used in simpler application where theming, searching and other
advanced controls are not needed.
To help you get started, we provide small example programs which you can
find in the examples/cpp directory of the sources. They are also available
......@@ -49,7 +41,6 @@ online at <a href="http://techbase.kde.org/Projects/Marble/MarbleCPlusPlus">KDE
@see Marble::MarbleWidget
@see Marble::MarbleModel
@see Marble::MarbleControlBox
@see Marble::MarbleNavigator
@see <a href="http://techbase.kde.org/Projects/Marble/MarbleCPlusPlus">KDE TechBase: MarbleCPlusPlus</a>
......
......@@ -196,7 +196,7 @@ class MarblePart: public KParts::ReadOnlyPart
private:
// All the functionality is provided by this widget.
ControlView *m_controlView; // MarbleControlBox and MarbleWidget
ControlView *m_controlView;
SunControlWidget *m_sunControlDialog;
TimeControlWidget *m_timeControlDialog;
DownloadRegionDialog *m_downloadRegionDialog;
......
//
// Copyright 2008 Simon Edwards <simon@simonzone.com>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library. If not, see <http://www.gnu.org/licenses/>.
//
namespace Marble
{
class MarbleControlBox : QWidget
{
%TypeHeaderCode
#include <MarbleControlBox.h>
%End
public:
explicit MarbleControlBox (QWidget* parent /TransferThis/ = 0);
void selectTheme (const QString&);
// FIXME PlacemarkModel header isn't installed
void setNavigationTabShown (bool show);
void setLegendTabShown (bool show);
void setMapViewTabShown (bool show);
void setCurrentLocationTabShown (bool show);
void setFileViewTabShown (bool show);
~MarbleControlBox ();
void setWorkOffline (bool offline);
void setRoutingTabShown (bool show);
signals:
void showMapWizard ();
void showUploadDialog ();
public:
Marble::CurrentLocationWidget* currentLocationWidget ();
void setMarbleWidget (Marble::MarbleWidget* widget);
signals:
void searchFinished ();
public:
void search (const QString& searchTerm, Marble::SearchMode searchMode);
};
// MarbleControlBox
};
// Marble
// Copyright 2010 Simon Edwards <simon@simonzone.com>
// Generated by twine2
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU Library General Public License as
// published by the Free Software Foundation; either version 2, or
// (at your option) any later version.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details
// You should have received a copy of the GNU Library General Public
// License along with this program; if not, write to the
// Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
namespace Marble
{
class NavigationWidget : QWidget
{
%TypeHeaderCode
#include <NavigationWidget.h>
%End
public:
NavigationWidget (QWidget* parent /TransferThis/ = 0, Qt::WindowFlags f = 0);
~NavigationWidget ();
void setMarbleWidget (Marble::MarbleWidget* widget);
signals:
void goHome ();
void zoomIn ();
void zoomOut ();
void zoomChanged (int zoom);
void moveLeft ();
void moveRight ();
void moveUp ();
void moveDown ();
public:
void selectTheme (const QString&);
void changeZoom (int zoom);
protected:
void resizeEvent (QResizeEvent*);
//FIXME
signals:
void searchFinished ();
public:
void search (const QString& searchTerm, Marble::SearchMode searchMode);
void clearSearch ();
};
};
......@@ -104,7 +104,6 @@
%Include MapWizard.sip
%Include MarbleAboutDialog.sip
%Include MarbleColors.sip
%Include MarbleControlBox.sip
%Include MarbleDirs.sip
%Include MarbleGlobal.sip
%Include MarbleGraphicsGridLayout.sip
......@@ -115,7 +114,6 @@
%Include MarbleRunnerManager.sip
%Include MarbleWebView.sip
%Include MarbleWidget.sip
%Include NavigationWidget.sip
%Include ParseRunnerPlugin.sip
%Include ParsingRunner.sip
%Include Planet.sip
......
......@@ -83,7 +83,6 @@ class StyleBuilder;
* cities, mountain tops or the poles.
*
* @see MarbleWidget
* @see MarbleControlBox
* @see MarbleModel
*/
......
......@@ -44,7 +44,6 @@ class MarbleNavigatorPrivate;
* Home position from the MarbleNavigator, though.
*
* @see MarbleWidget
* @see MarbleControlBox
*/
class MARBLE_EXPORT MarbleNavigator : public QWidget
......
......@@ -62,7 +62,7 @@ class StyleBuilder;
*
* This widget displays a view of the earth or any other globe,
* depending on which dataset is used. The user can navigate the
* globe using either a control widget, e.g. the MarbleControlBox, or
* globe using either a control widget, e.g. the MarbleNavigator, or
* the mouse. The mouse and keyboard control is done through a
* MarbleWidgetInputHandler. Only some aspects of the widget can be
* controlled by the mouse and/or keyboard.
......@@ -94,7 +94,7 @@ class StyleBuilder;
* Wikipedia to retrieve an article about it. If there is such an
* article, you will get a mini-browser window with the article in a tab.
*
* @see MarbleControlBox
* @see MarbleNavigator
* @see MarbleMap
* @see MarbleModel
*/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment