marble/src

MarbleControlBox Class Reference

#include <MarbleControlBox.h>

Inheritance diagram for MarbleControlBox:

Detailed Description

A widget class that contains advanced controls for a MarbleWidget.

This widget lets the user control an instance of MarbleWidget. The widget contains a ToolBox with 3 pages: a Navigation page with a search tool for cities and other names, a Legend page with a legend for the symbols on the map, and a Map View page with a choice of themes / datasets.

The Navigation page lets the user navigate around the globe by using buttons for panning and a slider for zooming. There is also a "Home" button that lets the user go back to a predefined point at the earth, not unlike the home page in a web browser. In addition there is a search tool that lets the user search for names of points of interest (cities, mountains, glaciers, etc).

The Legend page does not contain any controls, but displays a legend of the symbols that are displayed on the globe.

The Map View page gives the user a choice of different datasets to display, which can also be thought of as different visual themes. The default datasets are a standard Atlas view, a Night view, and a Sattelite view.

See also:: MarbleWidget
MarbleNavigator

Definition at line 71 of file MarbleControlBox.h.


Public Slots
void	changeZoom (int zoom)
void	disableGpsInput (bool)
void	receiveGpsCoordinates (double, double, GeoDataPoint::Unit)
void	enableFileViewActions ()
void	setNavigationTabShown (bool show)
void	setLegendTabShown (bool show)
void	setMapViewTabShown (bool show)
void	setCurrentLocationTabShown (bool show)
void	setFileViewTabShown (bool show)
Signals
void	goHome ()
void	zoomIn ()
void	zoomOut ()
void	zoomChanged (int zoom)
void	moveLeft ()
void	moveRight ()
void	moveUp ()
void	moveDown ()
void	centerOn (const QModelIndex &)
void	selectMapTheme (const QString &)
void	projectionSelected (int)
void	gpsInputDisabled (bool)
void	gpsPositionChanged (double lat, double lon)
void	updateGps ()
Public Member Functions
	MarbleControlBox (QWidget *parent=0)
	~MarbleControlBox ()
void	addMarbleWidget (MarbleWidget *widget)
void	setLocations (QAbstractItemModel *locations)
int	minimumZoom () const
void	updateMapThemes ()
Protected Member Functions
void	resizeEvent (QResizeEvent *)

Constructor & Destructor Documentation

MarbleControlBox::MarbleControlBox ( QWidget * parent = 0 )

Construct a new MarbleControlBox.

Parameters:

parent

the parent widget

Definition at line 65 of file MarbleControlBox.cpp.

MarbleControlBox::~MarbleControlBox ( )

Definition at line 146 of file MarbleControlBox.cpp.

Member Function Documentation

void MarbleControlBox::addMarbleWidget ( MarbleWidget * widget )

Add a MarbleWidget to be controlled by this widget.

Parameters:

widget

the MarbleWidget to be added.

Add a MarbleWidget so that it will be controlled by this widget. This call create all the connections of signals and slots that are necessary to have full control of the MarbleWidget, and thereby frees the programmer from doing it.

Definition at line 188 of file MarbleControlBox.cpp.

void MarbleControlBox::setLocations ( QAbstractItemModel * locations )

Set a list/set of placemark names for the search widget.

Parameters:

locations

the QAbstractitemModel containing the placemarks

This function is called to display a potentially large number of placemark names in a widget and let the user search between them.

See also:: centerOn

Definition at line 334 of file MarbleControlBox.cpp.

int MarbleControlBox::minimumZoom ( ) const

Return the minimum zoom level set in the widget.

Returns:: the minimum zoom level set in the widget.

Definition at line 340 of file MarbleControlBox.cpp.

void MarbleControlBox::updateMapThemes ( )

Update the list of Map Themes.

This should be called after the user has installed a new map theme, e.g. after he/she used GHNS.

Definition at line 153 of file MarbleControlBox.cpp.

void MarbleControlBox::goHome ( ) [signal]

Signal emitted when the Home button has been pressed.

void MarbleControlBox::zoomIn ( ) [signal]

Signal emitted when the Zoom In button has been pressed.

void MarbleControlBox::zoomOut ( ) [signal]

Signal emitted when the Zoom Out button has been pressed.

void MarbleControlBox::zoomChanged ( int zoom ) [signal]

Signal emitted when the zoom slider has been moved.

Parameters:

zoom

The new zoom value.

void MarbleControlBox::moveLeft ( ) [signal]

Signal emitted when the Move Left button has been pressed.

void MarbleControlBox::moveRight ( ) [signal]

Signal emitted when the Move Right button has been pressed.

void MarbleControlBox::moveUp ( ) [signal]

Signal emitted when the Move Up button has been pressed.

void MarbleControlBox::moveDown ( ) [signal]

Signal emitted when the Move Down button has been pressed.

void MarbleControlBox::centerOn ( const QModelIndex & ) [signal]

Signal emitted when a user selects a placemark in the search widget.

Parameters:

index

the index for the chosen placemark.

This signal is emitted when the user has selected a placemark in the search, e.g. by double clicking it or by pressing return. If it is connected to the centerOn( QModelIndex&) slot in a MarbleWidget, the widget will center the view on this placemark.

void MarbleControlBox::selectMapTheme ( const QString & ) [signal]

void MarbleControlBox::projectionSelected ( int ) [signal]

void MarbleControlBox::gpsInputDisabled ( bool ) [signal]

void MarbleControlBox::gpsPositionChanged	(	double	lat,
		double	lon
	)			`[signal]`

void MarbleControlBox::updateGps ( ) [signal]

void MarbleControlBox::changeZoom ( int zoom ) [slot]

Sets the value of the slider.

Parameters:

zoom

The new zoom value.

This slot should be called when the zoom value is changed from the widget itself, e.g. by using the scroll wheel. It sets the value of the slider, but nothing more. In particular it doesn't emit the zoomChanged signal.

Definition at line 346 of file MarbleControlBox.cpp.

void MarbleControlBox::disableGpsInput ( bool in ) [slot]

Definition at line 354 of file MarbleControlBox.cpp.

void MarbleControlBox::receiveGpsCoordinates	(	double	x,
		double	y,
		GeoDataPoint::Unit	unit
	)			`[slot]`

Definition at line 377 of file MarbleControlBox.cpp.

void MarbleControlBox::enableFileViewActions ( ) [slot]

Definition at line 412 of file MarbleControlBox.cpp.

void MarbleControlBox::setNavigationTabShown ( bool show ) [slot]

Control whether the Navigation tab is shown.

Parameters:

show

boolean that controls if the Navigation tab is shown.

Definition at line 432 of file MarbleControlBox.cpp.

void MarbleControlBox::setLegendTabShown ( bool show ) [slot]

Control whether the Legend tab is shown.

Parameters:

show

boolean that controls if the Legend tab is shown.

Definition at line 438 of file MarbleControlBox.cpp.

void MarbleControlBox::setMapViewTabShown ( bool show ) [slot]

Control whether the Map View tab is shown.

Parameters:

show

boolean that controls if the Map View tab is shown.

Definition at line 444 of file MarbleControlBox.cpp.

void MarbleControlBox::setCurrentLocationTabShown ( bool show ) [slot]

Control whether the Current Location tab is shown.

Parameters:

show

boolean that controls if the Current Location tab is shown.

Definition at line 450 of file MarbleControlBox.cpp.

void MarbleControlBox::setFileViewTabShown ( bool show ) [slot]

Control whether the File View tab is shown.

Parameters:

show

boolean that controls if the File View tab is shown.

Definition at line 456 of file MarbleControlBox.cpp.

void MarbleControlBox::resizeEvent ( QResizeEvent * ) [protected]

Reimplementation of the resizeEvent() of the widget.

If the MarbleControlBox gets shrunk enough, the slider in the Navigation tab will be hidden, leaving only the Zoom Up and Zoom Down buttons.

Reimplemented from QWidget.

Definition at line 465 of file MarbleControlBox.cpp.

The documentation for this class was generated from the following files:

marble/src

MarbleControlBox Class Reference

Detailed Description

Public Slots

Signals

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation

marble/src

kdeedu