Kstars

finderchart.h
1 /*
2  SPDX-FileCopyrightText: 2011 Rafał Kułaga <[email protected]>
3 
4  SPDX-License-Identifier: GPL-2.0-or-later
5 */
6 
7 #pragma once
8 
9 #include "kstarsdocument.h"
10 
11 class QString;
12 class QRectF;
13 class QImage;
14 
15 class LoggingForm;
16 class DetailsTable;
17 class KStarsDateTime;
18 class GeoLocation;
19 
20 /**
21  * @class FinderChart
22  * @brief Class that represents finder chart document.
23  * FinderChart class is a subclass of KStarsDocument class, representing finder chart.
24  * Finder chart can contain following elements: title, subtitle, description, logging forms,
25  * images and details tables.
26  *
27  * @author Rafał Kułaga
28  */
30 {
31  public:
32  /** Constructor */
33  FinderChart();
34 
35  /**
36  * @brief Insert title and subtitle to the finder chart.
37  * @param title Title.
38  * @param subtitle Subtitle.
39  */
40  void insertTitleSubtitle(const QString &title, const QString &subtitle);
41 
42  /**
43  * @brief Insert description to the finder chart.
44  * @param description Description text.
45  */
46  void insertDescription(const QString &description);
47 
48  /**
49  * @brief Insert details about date&time and geographic location.
50  * @param ut Date and time.
51  * @param geo Geographic location.
52  */
53  void insertGeoTimeInfo(const KStarsDateTime &ut, GeoLocation *geo);
54 
55  /**
56  * @brief Insert logging form to the finder chart.
57  * @param log Logging form to be inserted.
58  */
59  void insertLoggingForm(LoggingForm *log);
60 
61  /**
62  * @brief Insert image to the finder chart.
63  * @param img Image to be inserted.
64  * @param description Description of the image.s
65  * @param descriptionBelow True if description should be placed below image.
66  */
67  void insertImage(const QImage &img, const QString &description, bool descriptionBelow = true);
68 
69  /**
70  * @brief Insert details table to the finder chart.
71  * @param table Details table to be inserted.
72  */
73  void insertDetailsTable(DetailsTable *table);
74 
75  /**
76  * @brief Insert section title to the finder chart.
77  * @param title Section title.
78  */
79  void insertSectionTitle(const QString &title);
80 };
Extension of QDateTime for KStars KStarsDateTime can represent the date/time as a Julian Day,...
Class that represents finder chart document. FinderChart class is a subclass of KStarsDocument class,...
Definition: finderchart.h:29
void insertImage(const QImage &img, const QString &description, bool descriptionBelow=true)
Insert image to the finder chart.
FinderChart()
Constructor.
Definition: finderchart.cpp:20
Class that represents logging form. Currently, LoggingForm class is used to create logging forms for ...
Definition: loggingform.h:20
void insertDetailsTable(DetailsTable *table)
Insert details table to the finder chart.
void insertDescription(const QString &description)
Insert description to the finder chart.
Definition: finderchart.cpp:55
Base class for KStars documents. KStarsDocument is a base class for all KStars documents: finder char...
Represents details tables that can be inserted to finder charts and logging forms....
Definition: detailstable.h:28
void insertGeoTimeInfo(const KStarsDateTime &ut, GeoLocation *geo)
Insert details about date&time and geographic location.
Definition: finderchart.cpp:71
void insertLoggingForm(LoggingForm *log)
Insert logging form to the finder chart.
void insertSectionTitle(const QString &title)
Insert section title to the finder chart.
void insertTitleSubtitle(const QString &title, const QString &subtitle)
Insert title and subtitle to the finder chart.
Definition: finderchart.cpp:24
Relevant data about an observing location on Earth.
Definition: geolocation.h:27
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Aug 12 2022 04:00:53 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.