Kstars

finderchart.h
1/*
2 SPDX-FileCopyrightText: 2011 Rafał Kułaga <rl.kulaga@gmail.com>
3
4 SPDX-License-Identifier: GPL-2.0-or-later
5*/
6
7#pragma once
8
9#include "kstarsdocument.h"
10
11class QString;
12class QRectF;
13class QImage;
14
15class LoggingForm;
16class DetailsTable;
17class KStarsDateTime;
18class 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 */
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 */
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 */
74
75 /**
76 * @brief Insert section title to the finder chart.
77 * @param title Section title.
78 */
79 void insertSectionTitle(const QString &title);
80};
Represents details tables that can be inserted to finder charts and logging forms.
Class that represents finder chart document.
Definition finderchart.h:30
void insertDetailsTable(DetailsTable *table)
Insert details table to the finder chart.
void insertDescription(const QString &description)
Insert description to the finder chart.
void insertSectionTitle(const QString &title)
Insert section title to the finder chart.
FinderChart()
Constructor.
void insertLoggingForm(LoggingForm *log)
Insert logging form to the finder chart.
void insertTitleSubtitle(const QString &title, const QString &subtitle)
Insert title and subtitle to the finder chart.
void insertImage(const QImage &img, const QString &description, bool descriptionBelow=true)
Insert image to the finder chart.
void insertGeoTimeInfo(const KStarsDateTime &ut, GeoLocation *geo)
Insert details about date&time and geographic location.
Contains all relevant information for specifying a location on Earth: City Name, State/Province name,...
Definition geolocation.h:28
Extension of QDateTime for KStars KStarsDateTime can represent the date/time as a Julian Day,...
Base class for KStars documents.
Class that represents logging form.
Definition loggingform.h:21
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:38:43 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.