KStars Class Reference

This is the main window for KStars. More...

#include <kstars.h>

Inheritance diagram for KStars:


Classes
class	privatedata
Public Slots
void	clearCachedFindDialog ()
void	resumeDCOP (void)
void	slotApplyConfigChanges (void)
void	slotClearAllTrails ()
void	slotDefaultZoom ()
void	slotGeoLocator ()
void	slotSetZoom ()
void	slotTrack ()
void	slotZoomIn ()
void	slotZoomOut ()
void	updateTime (const bool automaticDSTchange=true)
Public Member Functions
void	addColorMenuItem (QString name, QString actionName)
void	applyConfig ()
ASYNC	changeViewOption (const QString option, const QString value)
KStarsData *	data ()
ASYNC	defaultZoom (void)
ASYNC	drawLine (int x1, int y1, int x2, int y2, int speed)
void	establishINDI ()
ASYNC	exportImage (const QString filename, int width, int height)
GeoLocation *	geo ()
INDIDriver *	getINDIDriver (void)
INDIMenu *	getINDIMenu (void)
QString	getOption (const QString &name)
InfoBoxes *	infoBoxes ()
	KStars (bool doSplash, bool startClockRunning=true, const QString &startDateString="")
ASYNC	loadColorScheme (const QString name)
ASYNC	lookTowards (const QString direction)
dms *	LST ()
SkyMap *	map ()
ObservingList *	observingList ()
ASYNC	popupMessage (int x, int y, const QString message)
ASYNC	printImage (bool usePrintDialog, bool useChartColors)
ASYNC	readConfig ()
void	removeColorMenuItem (QString actionName)
ASYNC	setAltAz (double alt, double az)
ASYNC	setColor (const QString colorName, const QString value)
ASYNC	setGeoLocation (const QString city, const QString province, const QString country)
ASYNC	setINDIAction (QString driverName, QString action)
ASYNC	setINDICCDTemp (QString deviceName, int temp)
ASYNC	setINDIFilterNum (QString deviceName, int filter_num)
ASYNC	setINDIFocusSpeed (QString driverName, unsigned int speed)
ASYNC	setINDIFocusTimeout (QString driverName, int timeout)
ASYNC	setINDIFrameType (QString deviceName, QString type)
ASYNC	setINDIGeoLocation (QString driverName, double longitude, double latitude)
ASYNC	setINDIPort (QString driverName, QString port)
ASYNC	setINDIScopeAction (QString deviceName, QString action)
ASYNC	setINDITargetCoord (QString driverName, double RA, double DEC)
ASYNC	setINDITargetName (QString driverName, QString objectName)
ASYNC	setINDIUTC (QString driverName, QString UTCDateTime)
ASYNC	setLocalTime (int yr, int mth, int day, int hr, int min, int sec)
ASYNC	setRaDec (double ra, double dec)
ASYNC	setTracking (bool track)
ASYNC	shutdownINDI (QString driverName)
ASYNC	startINDI (QString driverName, bool useLocal)
ASYNC	startINDIExposure (QString driverName, int timeout)
ASYNC	startINDIFocus (QString driverName, int focusDir)
ASYNC	switchINDI (QString driverName, bool turnOn)
ASYNC	waitFor (double t)
ASYNC	waitForINDIAction (QString driverName, QString action)
ASYNC	waitForKey (const QString k)
ASYNC	writeConfig ()
ASYNC	zoom (double z)
ASYNC	zoomIn (void)
ASYNC	zoomOut (void)
	~KStars ()

Detailed Description

This is the main window for KStars.

In addition to the GUI elements, the class contains the program clock, KStarsData, and SkyMap objects. It also contains functions for the DCOP interface.

Author:: Jason Harris

Version:: 1.0

Definition at line 67 of file kstars.h.

Constructor & Destructor Documentation

KStars::KStars	(	bool	doSplash,
		bool	startClockRunning = `true`,
		const QString &	startDateString = `""`
	)

Constructor.

Parameters:

	doSplash	should the splash panel be displayed during initialization.
	startClockRunning	should the clock be running on startup?
	startDateString	date (in string representation) to start running from.

Todo:: Refer to documentation on date format.

Definition at line 49 of file kstars.cpp.

KStars::~KStars ( )

Destructor.

Synchs config file. Deletes objects.

Definition at line 100 of file kstars.cpp.

Member Function Documentation

void KStars::addColorMenuItem	(	QString	name,
		QString	actionName
	)

Add an item to the color-scheme action manu.

Parameters:

	name	The name to use in the menu
	actionName	The internal name for the action (derived from filename)

Definition at line 1021 of file kstarsactions.cpp.

void KStars::applyConfig ( )

Apply config options throughout the program.

In most cases, options are set in the "Options" object directly, but for some things we have to manually react to config changes.

Definition at line 158 of file kstars.cpp.

void KStars::changeViewOption	(	const QString	option,
		const QString	value
	)			`[virtual]`

DCOP interface function.

modify a view option. option the name of the option to be modified value the option's new value

Implements KStarsInterface.

Definition at line 218 of file kstarsdcop.cpp.

void KStars::clearCachedFindDialog ( ) [slot]

Delete FindDialog because ObjNames list has changed in KStarsData due to reloading star data.

So list in FindDialog must be new filled with current data.

Delete findDialog only if it is not opened

Definition at line 143 of file kstars.cpp.

KStarsData * KStars::data ( void )

Returns:: pointer to KStarsData object which contains application data.

Definition at line 250 of file kstars.cpp.

ASYNC KStars::defaultZoom ( void ) [inline, virtual]

DCOP interface function.

reset to the default zoom level.

Implements KStarsInterface.

Definition at line 159 of file kstars.h.

void KStars::drawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	speed
	)			`[virtual]`

DCOP interface function.

Draw a line on the sky map.

Note:: Not Yet Implemented x1 starting x-coordinate of line y1 starting y-coordinate of line x2 ending x-coordinate of line y2 ending y-coordinate of line speed speed at which line should appear from start to end points (in pixels per second)

Implements KStarsInterface.

Definition at line 129 of file kstarsdcop.cpp.

void KStars::establishINDI ( )

Establish the INDI system.

No GUI

Definition at line 1031 of file kstarsactions.cpp.

void KStars::exportImage	(	const QString	filename,
		int	width,
		int	height
	)			`[virtual]`

DCOP interface function.

Export the sky image to a file. filename the filename for the exported image width the width for the exported image height the height for the exported image

Implements KStarsInterface.

Definition at line 391 of file kstarsdcop.cpp.

GeoLocation * KStars::geo ( )

Returns:: pointer to GeoLocation object which is the current geographic location.

Definition at line 256 of file kstars.cpp.

INDIDriver* KStars::getINDIDriver ( void ) [inline]

Returns:: pointer to the INDI driver

Definition at line 111 of file kstars.h.

INDIMenu* KStars::getINDIMenu ( void ) [inline]

Returns:: pointer to the INDI menu

Definition at line 115 of file kstars.h.

QString KStars::getOption ( const QString & name ) [virtual]

DCOP interface function.

name the name of the option to query

Returns:: the current value of the named option

Implements KStarsInterface.

Definition at line 207 of file kstarsdcop.cpp.

InfoBoxes * KStars::infoBoxes ( void )

Returns:: pointer to InfoBoxes object.

Definition at line 254 of file kstars.cpp.

void KStars::loadColorScheme ( const QString name ) [virtual]

DCOP interface function.

Load a color scheme. name the name of the color scheme to load (e.g., "Moonless Night")

Implements KStarsInterface.

Definition at line 343 of file kstarsdcop.cpp.

void KStars::lookTowards ( const QString direction ) [virtual]

DCOP interface function.

Point in the direction described by the string argument. direction either an object name, a compass direction (e.g., "north"), or "zenith"

Implements KStarsInterface.

Definition at line 59 of file kstarsdcop.cpp.

dms * KStars::LST ( )

Returns:: pointer to the local sidereal time.

Definition at line 260 of file kstars.cpp.

SkyMap * KStars::map ( void )

Returns:: pointer to SkyMap object which is the sky display widget.

Definition at line 252 of file kstars.cpp.

ObservingList * KStars::observingList ( )

Definition at line 262 of file kstars.cpp.

void KStars::popupMessage	(	int	x,
		int	y,
		const QString	message
	)			`[virtual]`

DCOP interface function.

Show text message in a popup window.

Note:: Not Yet Implemented x x-coordinate for message window y y-coordinate for message window message the text to display in the message window

Implements KStarsInterface.

Definition at line 125 of file kstarsdcop.cpp.

void KStars::printImage	(	bool	usePrintDialog,
		bool	useChartColors
	)			`[virtual]`

DCOP interface function.

Print the sky image. usePrintDialog if true, the KDE print dialog will be shown; otherwise, default parameters will be used useChartColors if true, the "Star Chart" color scheme will be used for the printout, which will save ink.

Implements KStarsInterface.

Definition at line 462 of file kstarsdcop.cpp.

void KStars::readConfig ( ) [virtual]

DCOP interface function.

Read config file. This function is useful for restoring the user settings from the config file, after having modified the settings in memory.

See also:: writeConfig()

Implements KStarsInterface.

Definition at line 185 of file kstarsdcop.cpp.

void KStars::removeColorMenuItem ( QString actionName )

Remove an item from the color-scheme action manu.

Parameters:

actionName

The internal name of the action (derived from filename)

Definition at line 1026 of file kstarsactions.cpp.

void KStars::resumeDCOP ( void ) [inline, slot]

Resume execution of DCOP commands.

Definition at line 433 of file kstars.h.

void KStars::setAltAz	(	double	alt,
		double	az
	)			`[virtual]`

DCOP interface function.

Set focus to given Alt/Az coordinates. alt the Altitude coordinate for the focus (in Degrees) az the Azimuth coordinate for the focus (in Degrees)

Implements KStarsInterface.

Definition at line 55 of file kstarsdcop.cpp.

void KStars::setColor	(	const QString	colorName,
		const QString	value
	)			`[virtual]`

DCOP interface function.

Modify a color. colorName the name of the color to be modified (e.g., "SkyColor") value the new color to use

Implements KStarsInterface.

Definition at line 335 of file kstarsdcop.cpp.

void KStars::setGeoLocation	(	const QString	city,
		const QString	province,
		const QString	country
	)			`[virtual]`

DCOP interface function.

Set the geographic location. city the city name of the location province the province name of the location country the country name of the location

Implements KStarsInterface.

Definition at line 133 of file kstarsdcop.cpp.

void KStars::setINDIAction	(	QString	driverName,
		QString	action
	)			`[virtual]`

DCOP interface function.

Set INDI action. driverName the name of the driver action the action to set

Implements KStarsInterface.

Definition at line 721 of file kstarsdcop.cpp.

void KStars::setINDICCDTemp	(	QString	deviceName,
		int	temp
	)			`[virtual]`

DCOP interface function.

Set CCD target temperature. deviceName the name of the CCD device temp the target CCD temperature (in Celsius ?)

Implements KStarsInterface.

Definition at line 1036 of file kstarsdcop.cpp.

void KStars::setINDIFilterNum	(	QString	deviceName,
		int	filter_num
	)			`[virtual]`

DCOP interface function.

Set CCD filter. deviceName the name of the CCD device filter_num identifier of the CCD filter

Implements KStarsInterface.

Definition at line 956 of file kstarsdcop.cpp.

void KStars::setINDIFocusSpeed	(	QString	driverName,
		unsigned int	speed
	)			`[virtual]`

DCOP interface function.

Set INDI focus speed. driverName the name of the driver action the name of the action (??)

Implements KStarsInterface.

Definition at line 788 of file kstarsdcop.cpp.

void KStars::setINDIFocusTimeout	(	QString	driverName,
		int	timeout
	)			`[virtual]`

DCOP interface function.

Sets focus operation timeout. driverName the name of the driver timeout the timeout interval, in seconds (?)

Implements KStarsInterface.

Definition at line 881 of file kstarsdcop.cpp.

void KStars::setINDIFrameType	(	QString	deviceName,
		QString	type
	)			`[virtual]`

DCOP interface function.

Set CCD camera frame type. deviceName the name of the CCD device type the frame type

Implements KStarsInterface.

Definition at line 1031 of file kstarsdcop.cpp.

void KStars::setINDIGeoLocation	(	QString	driverName,
		double	longitude,
		double	latitude
	)			`[virtual]`

DCOP interface function.

Set INDI geographical information. driverName the name of the driver longitude the longitude to set, in Degrees latitude the latitude to set, in Degrees

Implements KStarsInterface.

Definition at line 839 of file kstarsdcop.cpp.

void KStars::setINDIPort	(	QString	driverName,
		QString	port
	)			`[virtual]`

DCOP interface function.

Set INDI connection port. driverName the name of the driver for which the port will be set port the port identifier

Implements KStarsInterface.

Definition at line 600 of file kstarsdcop.cpp.

void KStars::setINDIScopeAction	(	QString	deviceName,
		QString	action
	)			`[virtual]`

DCOP interface function.

Set INDI Telescope action. deviceName the name of the telescope device action the action to set

Implements KStarsInterface.

Definition at line 1026 of file kstarsdcop.cpp.

void KStars::setINDITargetCoord	(	QString	driverName,
		double	RA,
		double	DEC
	)			`[virtual]`

DCOP interface function.

Set INDI target RA/DEC coordinates driverName the name of the driver RA the target's Right Ascension coordinate (in Hours) DEC the target's Declination coordinate (in Degrees)

Implements KStarsInterface.

Definition at line 636 of file kstarsdcop.cpp.

void KStars::setINDITargetName	(	QString	driverName,
		QString	objectName
	)			`[virtual]`

DCOP interface function.

Set INDI target to a named object. driverName the name of the driver objectName the name of the object to be targeted

Implements KStarsInterface.

Definition at line 677 of file kstarsdcop.cpp.

void KStars::setINDIUTC	(	QString	driverName,
		QString	UTCDateTime
	)			`[virtual]`

DCOP interface function.

Set INDI UTC date and time. driverName the name of the driver UTCDateTime the UTC date and time (e.g., "23 June 2004 12:30:00" ?)

Implements KStarsInterface.

Definition at line 992 of file kstarsdcop.cpp.

void KStars::setLocalTime	(	int	yr,
		int	mth,
		int	day,
		int	hr,
		int	min,
		int	sec
	)			`[virtual]`

DCOP interface function.

Set local time and date. yr year of date mth month of date day day of date hr hour of time min minute of time sec second of time

Implements KStarsInterface.

Definition at line 103 of file kstarsdcop.cpp.

void KStars::setRaDec	(	double	ra,
		double	dec
	)			`[virtual]`

DCOP interface function.

Set focus to given Ra/Dec coordinates ra the Right Ascension coordinate for the focus (in Hours) dec the Declination coordinate for the focus (in Degrees)

Implements KStarsInterface.

Definition at line 51 of file kstarsdcop.cpp.

void KStars::setTracking ( bool track ) [virtual]

DCOP interface function.

Toggle tracking. track engage tracking if true; else disengage tracking

Implements KStarsInterface.

Definition at line 121 of file kstarsdcop.cpp.

void KStars::shutdownINDI ( QString driverName ) [virtual]

DCOP interface function.

Shutdown an INDI driver. driverName the name of the driver to be shut down

Implements KStarsInterface.

Definition at line 545 of file kstarsdcop.cpp.

void KStars::slotApplyConfigChanges ( void ) [slot]

Apply new settings and redraw skymap.

Definition at line 377 of file kstarsactions.cpp.

void KStars::slotClearAllTrails ( ) [slot]

Remove all trails which may have been added to solar system bodies.

Definition at line 925 of file kstarsactions.cpp.

void KStars::slotDefaultZoom ( ) [slot]

action slot: Set the zoom level to its default value

Definition at line 747 of file kstarsactions.cpp.

void KStars::slotGeoLocator ( ) [slot]

action slot: open dialog for selecting a new geographic location

Definition at line 307 of file kstarsactions.cpp.

void KStars::slotSetZoom ( ) [slot]

action slot: Allow user to specify a field-of-view angle for the display window in degrees, and set the zoom level accordingly.

Definition at line 757 of file kstarsactions.cpp.

void KStars::slotTrack ( ) [slot]

action slot: Toggle whether kstars is tracking current position

Definition at line 640 of file kstarsactions.cpp.

void KStars::slotZoomIn ( ) [slot]

action slot: Zoom in one step

Definition at line 721 of file kstarsactions.cpp.

void KStars::slotZoomOut ( ) [slot]

action slot: Zoom out one step

Definition at line 734 of file kstarsactions.cpp.

void KStars::startINDI	(	QString	driverName,
		bool	useLocal
	)			`[virtual]`

DCOP interface function.

Establish an INDI driver. driverName the name of the driver to be established useLocal establish driver locally?

Implements KStarsInterface.

Definition at line 503 of file kstarsdcop.cpp.

void KStars::startINDIExposure	(	QString	driverName,
		int	timeout
	)			`[virtual]`

DCOP interface function.

Start camera exposure with a timeout. driverName the name of the driver timeout the exposure time, in seconds (?)

Implements KStarsInterface.

Definition at line 919 of file kstarsdcop.cpp.

void KStars::startINDIFocus	(	QString	driverName,
		int	focusDir
	)			`[virtual]`

DCOP interface function.

Set INDI focus direction and focus. driverName the name of the driver focusDir 0 = focus in; 1 = focus out

Implements KStarsInterface.

Definition at line 823 of file kstarsdcop.cpp.

void KStars::switchINDI	(	QString	driverName,
		bool	turnOn
	)			`[virtual]`

DCOP interface function.

Turn INDI driver on/off. driverName the name of the driver to be switched on/off turnOn if true, turn driver on; otherwise turn off

Implements KStarsInterface.

Definition at line 566 of file kstarsdcop.cpp.

void KStars::updateTime ( const bool automaticDSTchange = true ) [slot]

Update time-dependent data and (possibly) repaint the sky map.

automaticDSTchange change DST status automatically?

Definition at line 219 of file kstars.cpp.

void KStars::waitFor ( double t ) [virtual]

DCOP interface function.

Delay further execution of DCOP commands. t number of seconds to delay

Implements KStarsInterface.

Definition at line 107 of file kstarsdcop.cpp.

void KStars::waitForINDIAction	(	QString	driverName,
		QString	action
	)			`[virtual]`

DCOP interface function.

Pause DCOP execution until named INDI action is completed. driverName the name of the driver action the action which is to be completed before resuming DCOP execution

Implements KStarsInterface.

Definition at line 749 of file kstarsdcop.cpp.

void KStars::waitForKey ( const QString k ) [virtual]

DCOP interface function.

Pause further DCOP execution until a key is pressed. k the key which will resume DCOP execution

Implements KStarsInterface.

Definition at line 112 of file kstarsdcop.cpp.

void KStars::writeConfig ( ) [virtual]

DCOP interface function.

Write current settings to config file. This function is useful for storing user settings before modifying them with a DCOP script. The original settings can be restored with readConfig().

See also:: readConfig()

Implements KStarsInterface.

Definition at line 200 of file kstarsdcop.cpp.

void KStars::zoom ( double z ) [virtual]

DCOP interface function.

Set zoom level to specified value. a the zoom level. Units are pixels per radian.

Implements KStarsInterface.

Definition at line 96 of file kstarsdcop.cpp.

ASYNC KStars::zoomIn ( void ) [inline, virtual]

DCOP interface function.

Zoom in one step.

Implements KStarsInterface.

Definition at line 153 of file kstars.h.

ASYNC KStars::zoomOut ( void ) [inline, virtual]

DCOP interface function.

Zoom out one step.

Implements KStarsInterface.

Definition at line 156 of file kstars.h.

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

kstars

KStars Class Reference

Classes

Public Slots

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

kstars

API Reference