Kstars
kstars.h
84 KStarsData, and SkyMap objects. It also contains functions for the \ref DBusInterface D-Bus interface. KStars is now a singleton class. Use KStars::createInstance() to
94 Q_SCRIPTABLE Q_PROPERTY(QString colorScheme READ colorScheme WRITE loadColorScheme NOTIFY colorSchemeChanged)
109 explicit KStars(bool doSplash, bool startClockRunning = true, const QString &startDateString = QString());
120 static KStars *createInstance(bool doSplash, bool clockrunning = true, const QString &startDateString = QString());
211 KStars provides powerful scripting functionality via DBus. The most common DBus functions can be constructed and executed within the ScriptBuilder tool.
212 Any 3rd party language or tool with support for DBus can access several interfaces provided by KStars:
214 <li>KStars: Provides functions to manipulate the skymap including zoom, pan, and motion to selected objects. Add and remove object trails and labels. Wait for user input before running further actions.</li>
215 <li>SimClock: Provides functions to start and stop time, set a different date and time, and to set the clock scale.</li>
216 <li>Ekos: Provides functions to start and stop Ekos Manager, set Ekos connection mode, and access to Ekos modules:
218 <li>Capture: Provides functions to capture images, load sequence queues, control filter wheel, and obtain information on job progress.</li>
219 <li>Focus: Provides functions to focus control in manual and automated mode. Start and stop focusing procedures and set autofocus options.</li>
220 <li>Guide: Provides functions to start and stop calibration and autoguiding procedures. Set calibration and autoguide options.</li>
247 * @param 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)
370 * @param speed speed at which line should appear from start to end points (in pixels per second)
380 Q_SCRIPTABLE bool setGeoLocation(const QString &city, const QString &province, const QString &country);
402 Q_SCRIPTABLE bool setGPSLocation(double longitude, double latitude, double elevation, double tz0);
417 * @param width the width for the exported image. Map's width will be used if nothing or an invalid value is supplied.
418 * @param height the height for the exported image. Map's height will be used if nothing or an invalid value is supplied.
421 Q_SCRIPTABLE Q_NOREPLY void exportImage(const QString &filename, int width = -1, int height = -1,
436 Q_SCRIPTABLE QString getDSSURL(double RA_J2000, double Dec_J2000, float width = 15, float height = 15);
441 * @param storeInternetResolved If we fell back to the internet, save the result in DSO database for future offline access
455 * @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).
456 * @note Important: If imagePath is empty, but overlay is true, or destPathImage is supplied, this method will make a blocking DSS download.
458 Q_SCRIPTABLE Q_NOREPLY void renderEyepieceView(const QString &objectName, const QString &destPathChart,
476 /** DBUS interface function. Return a newline-separated list of objects in the observing wishlist.
477 * @note Unfortunately, unnamed objects are troublesome. Hopefully, we don't have them on the observing list.
481 /** DBUS interface function. Return a newline-separated list of objects in the observing session plan.
482 * @note Unfortunately, unnamed objects are troublesome. Hopefully, we don't have them on the observing list.
487 * @param usePrintDialog if true, the KDE print dialog will be shown; otherwise, default parameters will be used
488 * @param useChartColors if true, the "Star Chart" color scheme will be used for the printout, which will save ink.
493 * @param imageUrl URL of FITS image to load. For a local file the prefix must be file:// For example
Q_OBJECTQ_OBJECT
Q_SCRIPTABLE QString getObjectDataXML(const QString &objectName, bool fallbackToInternet=false, bool storeInternetResolved=true)
DBUS interface function.
Definition: kstarsdbus.cpp:738
Q_DECL_DEPRECATED Q_SCRIPTABLE QString getOption(const QString &name)
DBUS interface function.
Definition: kstarsdbus.cpp:375
void updateTime(const bool automaticDSTchange=true)
Update time-dependent data and (possibly) repaint the sky map.
Definition: kstars.cpp:556
Q_PROPERTY(...)
Q_SCRIPTABLE Q_NOREPLY void drawLine(int x1, int y1, int x2, int y2, int speed)
DBUS interface function.
Definition: kstarsdbus.cpp:248
bool isStartedWithClockRunning()
Was KStars started with the clock running, or paused?
Definition: kstars.h:835
Definition: scriptbuilder.h:93
void slotSetDomeEnabled(bool enable)
slotSetDomeEnabled call when dome comes online or goes offline.
Definition: kstarsactions.cpp:389
Class representing Printing Wizard for KStars printed documents (currently only finder charts).
Definition: printingwizard.h:52
Q_SCRIPTABLE Q_NOREPLY void removeTrail(const QString &name)
DBUS interface function.
Definition: kstarsdbus.cpp:172
Q_SLOTSQ_SLOTS
Definition: opsguides.h:18
Ekos is an advanced Astrophotography tool for Linux. It is based on a modular extensible framework to...
Definition: align.cpp:76
Q_SCRIPTABLE Q_NOREPLY void waitForKey(const QString &k)
DBUS interface function.
Definition: kstarsdbus.cpp:222
Stores dms coordinates for a point in the sky. for converting between coordinate systems.
Definition: skypoint.h:44
void slotSetTelescopeEnabled(bool enable)
slotSetTelescopeEnabled call when telescope comes online or goes offline.
Definition: kstarsactions.cpp:377
Q_CLASSINFO(Name, Value)
void slotSetTimeToNow()
action slot: sync kstars clock to system time
Definition: kstarsactions.cpp:1243
void slotToggleWIView()
action slot: toggle What's Interesting window
Definition: kstarsactions.cpp:570
Backends for exporting a sky image, either raster or vector, with a legend.
Definition: imageexporter.h:23
Q_SCRIPTABLE QString getObservingSessionPlanObjectNames()
DBUS interface function.
Definition: kstarsdbus.cpp:982
Definition: kstarsdata.h:71
bool event(QEvent *event) override
Q_SCRIPTABLE Q_NOREPLY void addLabel(const QString &name)
DBUS interface function.
Definition: kstarsdbus.cpp:142
Manages adding/removing and editing regions and points associated with user-customized artificial hor...
Definition: horizonmanager.h:40
Definition: wutdialog.h:39
void slotApplyConfigChanges()
Apply new settings and redraw skymap.
Definition: kstarsactions.cpp:1190
Manages the QML user interface for What's Interesting. WIView is used to display the QML UI using a Q...
Definition: wiview.h:32
Definition: opsterrain.h:19
Q_SCRIPTABLE Q_NOREPLY void lookTowards(const QString &direction)
DBUS interface function.
Definition: kstarsdbus.cpp:75
Q_SCRIPTABLE Q_NOREPLY void setColor(const QString &colorName, const QString &value)
DBUS interface function.
Definition: kstarsdbus.cpp:616
Q_SCRIPTABLE QString getObjectPositionInfo(const QString &objectName)
DBUS interface function.
Definition: kstarsdbus.cpp:819
Q_SCRIPTABLE Q_NOREPLY void changeViewOption(const QString &option, const QString &value)
DBUS interface function.
Definition: kstarsdbus.cpp:419
void slotSetZoom()
action slot: Allow user to specify a field-of-view angle for the display window in degrees,...
Definition: kstarsactions.cpp:1671
bool isVisible() const const
Q_SCRIPTABLE Q_NOREPLY void setAltAz(double alt, double az, bool altIsRefracted=false)
DBUS interface function.
Definition: kstarsdbus.cpp:61
Renders the view through the eyepiece of various telescope types.
Definition: eyepiecefield.h:36
User interface for "Light Pollution Settings" page in WI settings dialog This class deals with light ...
Definition: wilpsettings.h:22
Q_SCRIPTABLE bool setGeoLocation(const QString &city, const QString &province, const QString &country)
DBUS interface function.
Definition: kstarsdbus.cpp:271
User interface for "Equipment Type and Parameters" page in WI settings dialog.
Definition: wiequipsettings.h:23
Q_SCRIPTABLE Q_NOREPLY void loadColorScheme(const QString &name)
DBUS interface function.
Definition: kstarsdbus.cpp:631
the Altitude vs. Time Tool. Plot the altitude as a function of time for any list of objects,...
Definition: altvstime.h:40
static bool setResourceFile(QString const rc)
Override KStars UI resource file.
Definition: kstarsinit.cpp:125
Primary window to view monochrome and color FITS images. The FITSviewer can open multiple images each...
Definition: fitsviewer.h:49
void slotShowPositionBar(SkyPoint *)
Display position in the status bar.
Definition: kstarsactions.cpp:2070
Q_SCRIPTABLE Q_NOREPLY void setTracking(bool track)
DBUS interface function.
Definition: kstarsdbus.cpp:237
Q_SCRIPTABLE Q_NOREPLY void setLocalTime(int yr, int mth, int day, int hr, int min, int sec)
DBUS interface function.
Definition: kstarsdbus.cpp:202
Q_SCRIPTABLE Q_NOREPLY void renderEyepieceView(const QString &objectName, const QString &destPathChart, const double fovWidth=-1.0, const double fovHeight=-1.0, const double rotation=0.0, const double scale=1.0, const bool flip=false, const bool invert=false, QString imagePath=QString(), const QString &destPathImage=QString(), const bool overlay=false, const bool invertColors=false)
DBUS interface function.
Definition: kstarsdbus.cpp:918
This is the main window for KStars. In addition to the GUI elements, the class contains the program c...
Definition: kstars.h:90
Definition: opsfits.h:31
Definition: opssatellites.h:38
Q_SCRIPTABLE QString location()
location Returns a JSON Object (as string) that contains the following information: name: String prov...
Definition: kstarsdbus.cpp:253
Definition: opsdeveloper.h:24
Q_SCRIPTABLE Q_NOREPLY void openFITS(const QUrl &imageUrl)
DBUS interface function.
Definition: kstarsdbus.cpp:1057
Definition: opsadvanced.h:26
height
void slotTrack()
action slot: Toggle whether kstars is tracking current position
Definition: kstarsactions.cpp:1534
Primary class to handle all Ekos modules. The Ekos Manager class manages startup and shutdown of INDI...
Definition: manager.h:41
Composite spinbox for specifying a time step. This composite widget consists of a TimeSpinBox (a QSpi...
Definition: timestepbox.h:27
Q_SCRIPTABLE QString getObservingWishListObjectNames()
DBUS interface function.
Definition: kstarsdbus.cpp:971
Definition: obsconditions.h:21
Q_SCRIPTABLE Q_NOREPLY void exportImage(const QString &filename, int width=-1, int height=-1, bool includeLegend=false)
DBUS interface function.
Definition: kstarsdbus.cpp:703
objectName
Canvas widget for displaying the sky bitmap; also handles user interaction events.
Definition: skymap.h:53
Q_SCRIPTABLE Q_NOREPLY void printImage(bool usePrintDialog, bool useChartColors)
DBUS interface function.
Definition: kstarsdbus.cpp:1002
Q_SCRIPTABLE Q_NOREPLY void setRaDec(double ra, double dec)
DBUS interface function.
Definition: kstarsdbus.cpp:44
void slotWISettings()
action slot: open What's Interesting settings window
Definition: kstarsactions.cpp:542
void removeColorMenuItem(const QString &actionName)
Remove an item from the color-scheme action manu.
Definition: kstarsactions.cpp:2023
void addColorMenuItem(QString name, const QString &actionName)
Add an item to the color-scheme action manu.
Definition: kstarsactions.cpp:2001
Q_SCRIPTABLE Q_NOREPLY void removeLabel(const QString &name)
DBUS interface function.
Definition: kstarsdbus.cpp:152
Q_SCRIPTABLE Q_NOREPLY void setApproxFOV(double FOV_Degrees)
DBUS interface function.
Definition: kstarsdbus.cpp:993
Definition: execute.h:24
Q_SCRIPTABLE Q_NOREPLY void setRaDecJ2000(double ra0, double dec0)
DBUS interface function.
Definition: kstarsdbus.cpp:51
Definition: opsindi.h:22
void clearCachedFindDialog()
Delete FindDialog because ObjNames list has changed in KStarsData due to reloading star data.
Definition: kstars.cpp:292
width
Q_SCRIPTABLE Q_NOREPLY void addTrail(const QString &name)
DBUS interface function.
Definition: kstarsdbus.cpp:162
Q_SCRIPTABLE Q_NOREPLY void popupMessage(int x, int y, const QString &message)
DBUS interface function.
Definition: kstarsdbus.cpp:243
Definition: opsimageoverlay.h:19
Q_SCRIPTABLE QString getDSSURL(const QString &objectName)
DBUS interface function.
Definition: kstarsdbus.cpp:719
void slotClearAllTrails()
Remove all trails which may have been added to solar system bodies.
Definition: kstarsactions.cpp:1958
void slotGeoLocator()
action slot: open dialog for selecting a new geographic location
Definition: kstarsactions.cpp:1023
Definition: opsekos.h:21
void applyConfig(bool doApplyFocus=true)
Apply config options throughout the program.
Definition: kstars.cpp:310
static KStars * createInstance(bool doSplash, bool clockrunning=true, const QString &startDateString=QString())
Create an instance of this class.
Definition: kstars.cpp:238
Q_SCRIPTABLE bool setGPSLocation(double longitude, double latitude, double elevation, double tz0)
DBUS interface function.
Definition: kstarsdbus.cpp:325
QString message
void slotEyepieceView(SkyPoint *sp, const QString &imagePath=QString())
Show the eyepiece view tool.
Definition: kstarsactions.cpp:1877
Definition: opssupernovae.h:26
Definition: skycalendar.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Dec 6 2023 04:05:15 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2023 The KDE developers.
Generated on Wed Dec 6 2023 04:05:15 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.