kstars/kstars/detaildialog.h

   1 /***************************************************************************
   2                           detaildialog.h  -  description
   3                              -------------------
   4     begin                : Sun May 5 2002
   5     copyright            : (C) 2002 by Jason Harris
   6     email                : kstars@30doradus.org
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef DETAILDIALOG_H
  19 #define DETAILDIALOG_H
  20
  21 #include <qfile.h>
  22 #include <qlabel.h>
  23 #include <qptrlist.h>
  24 #include <kdialogbase.h>
  25 #include <ktextedit.h>
  26
  27 #include "skyobject.h"
  28
  29 class GeoLocation;
  30 class QHBoxLayout;
  31 class QLineEdit;
  32 class QFile;
  33 class QPixmap;
  34 class QString;
  35 class QStringList;
  36 class KStars;
  37 class KStarsDateTime;
  38
  39 class DetailsDataUI;
  40 class DetailsPositionUI;
  41 class DetailsLinksUI;
  42 class DetailsDatabaseUI;
  43 class DetailsLogUI;
  44
  45 struct ADVTreeData
  46 {
  47         QString Name;
  48         QString Link;
  49         int Type;
  50 };
  51
  52 /**@class LogEdit is a simple derivative of KTextEdit, that just adds a
  53         *focusOut() signal, emitted when the edit loses focus.
  54         *@author Jason Harris
  55         *@version 1.0
  56         */
  57 class LogEdit : public KTextEdit {
  58         Q_OBJECT
  59 public:
  60         LogEdit( QWidget *parent=0, const char *name=0 );
  61         ~LogEdit() {}
  62
  63 signals:
  64         void focusOut();
  65
  66 protected:
  67         void focusOutEvent( QFocusEvent *e );
  68 };
  69
  70 /**@class ClickLabel is a QLabel with a clicked() signal.
  71         *@author Jason Harris
  72         *@version 1.0
  73         */
  74 class ClickLabel : public QLabel {
  75         Q_OBJECT
  76 public:
  77         ClickLabel( QWidget *parent=0, const char *name=0 );
  78         ~ClickLabel() {}
  79
  80 signals:
  81         void clicked();
  82
  83 protected:
  84         void mousePressEvent( QMouseEvent * ) { emit clicked(); }
  85 };
  86
  87 /**@class DetailDialog is a window showing detailed information for a selected object.
  88         *The window is split into four Tabs: General, Links, Advanced and Log.
  89         *The General Tab displays some type-specific data about the object, as well as its
  90         *present coordinates and Rise/Set/Transit times for the current date.  The Type-specific
  91         *data are:
  92         *@li Stars: common name, genetive name, Spectral type, magnitude, distance
  93         *@li Solar System: name, object type (planet/comet/asteroid), Distance, magnitude (TBD),
  94         *angular size (TBD)
  95         *@li Deep Sky: Common name, other names, object type, magnitude, angular size
  96         *
  97         *The Links Tab allows the user to manage the list of Image and Information links
  98         *listed in the object's popup menu.  The Advanced Tab allows the user to query
  99         *a number of professional-grade online astronomical databases for data on the object.
 100         *The Log tab allows the user to attach their own text notes about the object.
 101         *@author Jason Harris, Jasem Mutlaq
 102         *@version 1.0
 103         */
 104
 105 class DetailDialog : public KDialogBase  {
 106    Q_OBJECT
 107 public:
 108 /**Constructor
 109         */
 110         DetailDialog(SkyObject *o, const KStarsDateTime &ut, GeoLocation *geo, QWidget *parent=0, const char *name=0);
 111
 112 /**Destructor (empty)
 113         */
 114         ~DetailDialog() {}
 115
 116         QPixmap* thumbnail() { return Thumbnail; }
 117
 118 public slots:
 119 /**@short Add this object to the observing list.
 120         */
 121         void addToObservingList();
 122
 123 /**@short Center this object in the display.
 124         */
 125         void centerMap();
 126
 127 /**@short Center this object in the telescope.
 128         */
 129         void centerTelescope();
 130
 131 /**@short Display thumbnail image for the object
 132         */
 133         void showThumbnail();
 134
 135 /**@short Update thumbnail image for the object
 136         */
 137         void updateThumbnail();
 138
 139 /**@short View the selected image or info URL in the web browser.
 140         */
 141         void viewLink();
 142
 143 /**@short Unselect the currently selected item in the Images list
 144         *@note used when an item is selected in the Info list
 145         */
 146         void unselectImagesList();
 147
 148 /**@short Unselect the currently selected item in the Info list
 149         *@note used when an item is selected in the Images list
 150         */
 151         void unselectInfoList();
 152
 153 /**@short Rebuild the Image and Info URL lists for this object.
 154         *@note used when an item is added to either list.
 155         */
 156         void updateLists();
 157
 158 /**@short Open a dialog to edit a URL in either the Images or Info lists,
 159         *and update the user's *url.dat file.
 160         */
 161         void editLinkDialog();
 162
 163 /**@short remove a URL entry from either the Images or Info lists, and
 164         *update the user's *url.dat file.
 165         */
 166         void removeLinkDialog();
 167
 168 /**Open the web browser to the selected online astronomy database,
 169         *with a query to the object of this Detail Dialog.
 170         */
 171         void viewADVData();
 172
 173 /**Save the User's text in the Log Tab to the userlog.dat file.
 174         */
 175         void saveLogData();
 176
 177 private:
 178
 179 /**Read in the user's customized URL file (either images or info webpages),
 180         *and store the file's lines in a QStringList.
 181         *@param type 0=Image URLs; 1=Info URLs
 182         */
 183         bool readUserFile(int type);
 184
 185 /**Parse the QStringList containing the User's URLs.
 186         *@param type 0=Image URLs; 1=Info URLs
 187         */
 188         bool verifyUserData(int type);
 189
 190 /**Build the General Data Tab for the current object.
 191         */
 192         void createGeneralTab();
 193
 194 /**Build the Position Tab for the current object.
 195         */
 196         void createPositionTab( const KStarsDateTime &ut, GeoLocation *geo );
 197
 198 /**Build the Links Tab, populating the image and info lists with the
 199         *known URLs for the current Object.
 200         */
 201         void createLinksTab();
 202
 203 /**Build the Advanced Tab
 204         */
 205         void createAdvancedTab();
 206
 207 /**Build the Log Tab
 208         */
 209         void createLogTab();
 210
 211
 212 /**Populate the TreeView of known astronomical databases in the Advanced Tab
 213         */
 214         void populateADVTree(QListViewItem *parent);
 215
 216 /**For the databases TreeView
 217         */
 218         void forkTree(QListViewItem *parent);
 219
 220 /**Data for the Advanced Tab TreeView is stored in the file advinterface.dat.
 221         *This function parses advinterface.dat.
 222         */
 223         QString parseADVData(QString link);
 224
 225
 226         SkyObject *selectedObject;
 227         KStars* ksw;
 228
 229         // Edit Link Dialog
 230         QHBoxLayout *editLinkLayout;
 231         QLabel *editLinkURL;
 232         QLineEdit *editLinkField;
 233         QFile file;
 234         QPixmap *Thumbnail;
 235         int currentItemIndex;
 236         QString currentItemURL, currentItemTitle;
 237         QStringList dataList;
 238
 239         QPtrListIterator<ADVTreeData> * treeIt;
 240
 241         DetailsDataUI *Data;
 242         DetailsPositionUI *Pos;
 243         DetailsLinksUI *Links;
 244         DetailsDatabaseUI *Adv;
 245         DetailsLogUI *Log;
 246
 247 };
 248
 249 #endif