KStars
#include <kstars.h>
Signals | |
void | colorSchemeChanged () |
Static Public Attributes | |
static bool | Closing = false |
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 DBus Interface D-Bus interface. KStars is now a singleton class. Use KStars::createInstance() to create an instance and KStars::Instance() to get a pointer to the instance
- Version
- 1.1
Property Documentation
◆ colorScheme
|
readwrite |
Constructor & Destructor Documentation
◆ ~KStars()
|
override |
Destructor.
Definition at line 248 of file kstars.cpp.
Member Function Documentation
◆ addColorMenuItem()
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 2054 of file kstarsactions.cpp.
◆ addLabel
DBUS interface function.
Add a name label to the named object
- Parameters
-
name the name of the object to which the label will be attached
Definition at line 142 of file kstarsdbus.cpp.
◆ addTrail
DBUS interface function.
Add a trail to the named solar system body
- Parameters
-
name the name of the body to which the trail will be attached
Definition at line 162 of file kstarsdbus.cpp.
◆ applyConfig()
void KStars::applyConfig | ( | bool | doApplyFocus = true | ) |
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.
- Parameters
-
doApplyFocus If true, then focus position will be set from config file
Note: This uses style sheets to set the dark colors, this should be cross platform. Palettes have a different behavior on OS X and Windows as opposed to Linux. It might be a good idea to use stylesheets in the future instead of palettes but this will work for now for OS X. This is also in KStarsDbus.cpp. If you change it, change it in BOTH places.
Definition at line 311 of file kstars.cpp.
◆ changeViewOption
DBUS interface function.
modify a view option.
- Parameters
-
option the name of the option to be modified value the option's new value
Definition at line 419 of file kstarsdbus.cpp.
◆ 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.
Definition at line 293 of file kstars.cpp.
◆ colorScheme()
QString KStars::colorScheme | ( | ) | const |
Definition at line 626 of file kstarsdbus.cpp.
◆ colorSchemeChanged
|
signal |
DBUS interface notification.
Color scheme was updated.
◆ createInstance()
|
static |
Create an instance of this class.
Destroy any previous instance
- Parameters
-
doSplash clockrunning startDateString
- Note
- See KStars::KStars for details on parameters
- Returns
- a pointer to the instance
Definition at line 239 of file kstars.cpp.
◆ data()
|
inline |
- Returns
- pointer to KStarsData object which contains application data.
◆ defaultZoom
|
slot |
DBUS interface function.
reset to the default zoom level.
Definition at line 197 of file kstarsdbus.cpp.
◆ drawLine
|
slot |
DBUS interface function.
Draw a line on the sky map.
- Note
- Not Yet Implemented
- Parameters
-
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)
Definition at line 248 of file kstarsdbus.cpp.
◆ exportImage
|
slot |
DBUS interface function.
Export the sky image to a file.
- Parameters
-
filename the filename for the exported image width the width for the exported image. Map's width will be used if nothing or an invalid value is supplied. height the height for the exported image. Map's height will be used if nothing or an invalid value is supplied. includeLegend should we include a legend?
Definition at line 703 of file kstarsdbus.cpp.
◆ flagManager()
|
inline |
◆ getDSSURL [1/2]
DBUS interface function.
Return a URL to retrieve Digitized Sky Survey image.
- Parameters
-
objectName name of the object.
- Note
- If the object is note found, the string "ERROR" is returned.
Definition at line 719 of file kstarsdbus.cpp.
◆ getDSSURL [2/2]
|
slot |
DBUS interface function.
Return a URL to retrieve Digitized Sky Survey image.
- Parameters
-
RA_J2000 J2000.0 RA Dec_J2000 J2000.0 Declination width width of the image, in arcminutes (default = 15) height height of the image, in arcminutes (default = 15)
Definition at line 732 of file kstarsdbus.cpp.
◆ getFocusInformationXML
|
slot |
DBUS interface function.
Get the focus information as XML.
Definition at line 395 of file kstarsdbus.cpp.
◆ getObjectDataXML
|
slot |
DBUS interface function.
Return XML containing information about a sky object
- Parameters
-
objectName name of the object. fallbackToInternet Attempt to resolve the name using internet databases if not found storeInternetResolved If we fell back to the internet, save the result in DSO database for future offline access
- Note
- If the object was not found, the XML is empty.
Definition at line 738 of file kstarsdbus.cpp.
◆ getObjectPositionInfo
DBUS interface function.
Return XML containing position info about a sky object
- Parameters
-
objectName name of the object.
- Note
- If the object was not found, the XML is empty.
Definition at line 819 of file kstarsdbus.cpp.
◆ getObservingSessionPlanObjectNames
|
slot |
DBUS interface function.
Return a newline-separated list of objects in the observing session plan.
- Note
- Unfortunately, unnamed objects are troublesome. Hopefully, we don't have them on the observing list.
Definition at line 982 of file kstarsdbus.cpp.
◆ getObservingWishListObjectNames
|
slot |
DBUS interface function.
Return a newline-separated list of objects in the observing wishlist.
- Note
- Unfortunately, unnamed objects are troublesome. Hopefully, we don't have them on the observing list.
Definition at line 971 of file kstarsdbus.cpp.
◆ getOption
DBUS interface function.
- Parameters
-
name the name of the option to query
- Returns
- the current value of the named option
- Note
- Deprecated because it's not clear how to list the options
Definition at line 375 of file kstarsdbus.cpp.
◆ getSkyMapDimensions
|
slot |
DBUS interface function.
Get the dimensions of the Sky Map.
- Returns
- a string containing widthxheight in pixels.
Definition at line 998 of file kstarsdbus.cpp.
◆ getWIEquipSettings()
|
inline |
◆ hideAllFovExceptFirst()
void KStars::hideAllFovExceptFirst | ( | ) |
Definition at line 456 of file kstars.cpp.
◆ Instance()
◆ isGUIReady()
|
inline |
◆ isStartedWithClockRunning()
|
inline |
◆ isWIVisible
◆ loadColorScheme
DBUS interface function.
Load a color scheme.
- Parameters
-
name the name of the color scheme to load (e.g., "Moonless Night")
Definition at line 631 of file kstarsdbus.cpp.
◆ location
|
slot |
location Returns a JSON Object (as string) that contains the following information: name: String province: String country: String longitude: Double (-180 to +180) latitude: Double (-90 to +90) tz0 (Time zone without DST): Double tz (Time zone with DST): Double
- Returns
- Stringified JSON object as described above.
Definition at line 253 of file kstarsdbus.cpp.
◆ lookTowards
DBUS interface function.
Point in the direction described by the string argument.
- Parameters
-
direction either an object name, a compass direction (e.g., "north"), or "zenith"
Definition at line 75 of file kstarsdbus.cpp.
◆ map()
|
inline |
◆ openFITS
DBUS interface function.
Open FITS image.
- Parameters
-
imageUrl URL of FITS image to load. For a local file the prefix must be file:// For example if the file is located at /home/john/m42.fits then the full URL is file:///home/john/m42.fits
Definition at line 1057 of file kstarsdbus.cpp.
◆ popupMessage
DBUS interface function.
Show text message in a popup window.
- Note
- Not Yet Implemented
- Parameters
-
x x-coordinate for message window y y-coordinate for message window message the text to display in the message window
Definition at line 243 of file kstarsdbus.cpp.
◆ printImage
|
slot |
DBUS interface function.
Print the sky image.
- Parameters
-
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.
Definition at line 1002 of file kstarsdbus.cpp.
◆ printingWizard()
|
inline |
◆ readConfig
|
slot |
DBUS 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()
Definition at line 350 of file kstarsdbus.cpp.
◆ releaseResources()
void KStars::releaseResources | ( | ) |
◆ removeColorMenuItem()
Remove an item from the color-scheme action manu.
- Parameters
-
actionName The internal name of the action (derived from filename)
Definition at line 2076 of file kstarsactions.cpp.
◆ removeLabel
DBUS interface function.
Remove a name label from the named object
- Parameters
-
name the name of the object from which the label will be removed
Definition at line 152 of file kstarsdbus.cpp.
◆ removeTrail
DBUS interface function.
Remove a trail from the named solar system body
- Parameters
-
name the name of the object from which the trail will be removed
Definition at line 172 of file kstarsdbus.cpp.
◆ renderEyepieceView
|
slot |
DBUS interface function.
Render eyepiece view and save it in the file(s) specified
- Note
- See EyepieceField::renderEyepieceView() for more info. This is a DBus proxy that calls that method, and then writes the resulting image(s) to file(s).
- Important: If imagePath is empty, but overlay is true, or destPathImage is supplied, this method will make a blocking DSS download.
Definition at line 918 of file kstarsdbus.cpp.
◆ repopulateHIPS()
void KStars::repopulateHIPS | ( | ) |
Load HIPS information and repopulate menu.
Definition at line 844 of file kstarsinit.cpp.
◆ repopulateOrientation()
void KStars::repopulateOrientation | ( | ) |
Definition at line 723 of file kstarsinit.cpp.
◆ repopulateViews()
void KStars::repopulateViews | ( | ) |
Load Views and repopulate menu.
Definition at line 789 of file kstarsinit.cpp.
◆ selectNextFov()
void KStars::selectNextFov | ( | ) |
Definition at line 484 of file kstars.cpp.
◆ selectNextView()
void KStars::selectNextView | ( | ) |
Definition at line 552 of file kstars.cpp.
◆ selectPreviousFov()
void KStars::selectPreviousFov | ( | ) |
Definition at line 518 of file kstars.cpp.
◆ selectPreviousView()
void KStars::selectPreviousView | ( | ) |
Definition at line 565 of file kstars.cpp.
◆ setAltAz
|
slot |
DBUS interface function.
Set focus to given Alt/Az coordinates.
- Parameters
-
alt the Altitude coordinate for the focus (in Degrees) az the Azimuth coordinate for the focus (in Degrees) altIsRefracted If set to true, the altitude is interpreted as if it were corrected for atmospheric refraction (i.e. the altitude is an apparent altitude)
Definition at line 61 of file kstarsdbus.cpp.
◆ setApproxFOV
|
slot |
DBUS interface function.
Set the approx field-of-view
- Parameters
-
FOV_Degrees field of view in degrees
Definition at line 993 of file kstarsdbus.cpp.
◆ setColor
DBUS interface function.
Modify a color.
- Parameters
-
colorName the name of the color to be modified (e.g., "SkyColor") value the new color to use
Definition at line 616 of file kstarsdbus.cpp.
◆ setGeoLocation
|
slot |
DBUS interface function.
Set the geographic location.
- Parameters
-
city the city name of the location province the province name of the location country the country name of the location
- Returns
- True if geographic location is found and set, false otherwise.
Definition at line 271 of file kstarsdbus.cpp.
◆ setGPSLocation
|
slot |
DBUS interface function.
Set the GPS geographic location.
- Parameters
-
longitude longitude in degrees (-180 West to +180 East) latitude latitude in degrees (-90 South to +90 North) elevation site elevation in meters tz0 Time zone offset WITHOUT daylight saving time.
- Returns
- True if geographic location is set, false otherwise.
Definition at line 325 of file kstarsdbus.cpp.
◆ setLocalTime
|
slot |
DBUS interface function.
Set local time and date.
- Parameters
-
yr year of date mth month of date day day of date hr hour of time min minute of time sec second of time
Definition at line 202 of file kstarsdbus.cpp.
◆ setRaDec
|
slot |
DBUS interface function.
Set focus to given Ra/Dec coordinates
- Parameters
-
ra the Right Ascension coordinate for the focus (in Hours) dec the Declination coordinate for the focus (in Degrees)
Definition at line 44 of file kstarsdbus.cpp.
◆ setRaDecJ2000
|
slot |
DBUS interface function.
Set focus to given J2000.0 Ra/Dec coordinates
- Parameters
-
ra the J2000.0 Right Ascension coordinate for the focus (in Hours) dec the J2000.0 Declination coordinate for the focus (in Degrees)
Definition at line 51 of file kstarsdbus.cpp.
◆ setResourceFile()
Override KStars UI resource file.
- Note
- This is used by UI tests, which need to use the same resources with a different app name
Definition at line 125 of file kstarsinit.cpp.
◆ setTimeToNow
|
slot |
DBUS interface function.
Set local time and date to present values acc. system clock
- Note
- Just a proxy for slotSetTimeToNow(), but it is better to keep the DBus interface separate from the internal methods.
Definition at line 207 of file kstarsdbus.cpp.
◆ setTracking
|
slot |
DBUS interface function.
Toggle tracking.
- Parameters
-
track engage tracking if true; else disengage tracking
Definition at line 237 of file kstarsdbus.cpp.
◆ showImgExportDialog()
void KStars::showImgExportDialog | ( | ) |
Definition at line 430 of file kstars.cpp.
◆ showWISettingsUI()
void KStars::showWISettingsUI | ( | ) |
Definition at line 580 of file kstars.cpp.
◆ slotApplyConfigChanges
|
slot |
Apply new settings and redraw skymap.
Definition at line 1192 of file kstarsactions.cpp.
◆ slotApplyWIConfigChanges
|
slot |
Apply new settings for WI.
Definition at line 1202 of file kstarsactions.cpp.
◆ slotClearAllTrails
|
slot |
Remove all trails which may have been added to solar system bodies.
Definition at line 2011 of file kstarsactions.cpp.
◆ slotDSOCatalogGUI
|
slot |
Show the DSO Catalog Management GUI.
Definition at line 2189 of file kstarsactions.cpp.
◆ slotEyepieceView
Show the eyepiece view tool.
Definition at line 1930 of file kstarsactions.cpp.
◆ slotFlagManager
|
slot |
action slot: open Flag Manager
Definition at line 645 of file kstarsactions.cpp.
◆ slotGeoLocator
|
slot |
action slot: open dialog for selecting a new geographic location
Definition at line 1025 of file kstarsactions.cpp.
◆ slotSetDomeEnabled
|
slot |
slotSetDomeEnabled call when dome comes online or goes offline.
- Parameters
-
enable True if dome is online and connected, false otherwise.
Definition at line 391 of file kstarsactions.cpp.
◆ slotSetTelescopeEnabled
|
slot |
slotSetTelescopeEnabled call when telescope comes online or goes offline.
- Parameters
-
enable True if telescope is online and connected, false otherwise.
Definition at line 379 of file kstarsactions.cpp.
◆ slotSetTimeToNow
|
slot |
action slot: sync kstars clock to system time
Definition at line 1245 of file kstarsactions.cpp.
◆ 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 1663 of file kstarsactions.cpp.
◆ slotShowPositionBar
|
slot |
Display position in the status bar.
Definition at line 2123 of file kstarsactions.cpp.
◆ slotToggleWIView
|
slot |
action slot: toggle What's Interesting window
Definition at line 572 of file kstarsactions.cpp.
◆ slotTrack
|
slot |
action slot: Toggle whether kstars is tracking current position
Definition at line 1526 of file kstarsactions.cpp.
◆ slotWISettings
|
slot |
action slot: open What's Interesting settings window
Definition at line 544 of file kstarsactions.cpp.
◆ slotWizard
|
slot |
action slot: open KStars startup wizard
Definition at line 412 of file kstarsactions.cpp.
◆ slotZoomChanged
|
slot |
Called when zoom level is changed.
Enables/disables zoom actions and updates status bar.
Definition at line 1635 of file kstarsactions.cpp.
◆ syncFOVActions()
void KStars::syncFOVActions | ( | ) |
Definition at line 436 of file kstars.cpp.
◆ syncOps()
void KStars::syncOps | ( | ) |
Sync Options to GUI, if any.
Definition at line 1181 of file kstarsactions.cpp.
◆ updateLocationFromWizard
|
slot |
Definition at line 423 of file kstarsactions.cpp.
◆ updateTime
Update time-dependent data and (possibly) repaint the sky map.
- Parameters
-
automaticDSTchange change DST status automatically?
Definition at line 586 of file kstars.cpp.
◆ waitFor
|
slot |
DBUS interface function.
Delay further execution of DBUS commands.
- Parameters
-
t number of seconds to delay
Definition at line 212 of file kstarsdbus.cpp.
◆ waitForKey
DBUS interface function.
Pause further DBUS execution until a key is pressed.
- Parameters
-
k the key which will resume DBUS execution
Definition at line 222 of file kstarsdbus.cpp.
◆ wiView
◆ writeConfig
|
slot |
DBUS interface function.
Write current settings to config file. This function is useful for storing user settings before modifying them with a DBUS script. The original settings can be restored with readConfig().
- See also
- readConfig()
Definition at line 367 of file kstarsdbus.cpp.
◆ zoom
|
slot |
DBUS interface function.
Set zoom level to specified value.
- Parameters
-
z the zoom level. Units are pixels per radian.
Definition at line 182 of file kstarsdbus.cpp.
◆ zoomIn
|
slot |
◆ zoomOut
|
slot |
Member Data Documentation
◆ Closing
|
static |
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:19:04 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.