kstars/kstars/indielement.h

   1 /*  INDI Element
   2     Copyright (C) 2003 Jasem Mutlaq (mutlaqja@ikarustech.com)
   3
   4     This application is free software; you can redistribute it and/or
   5     modify it under the terms of the GNU General Public
   6     License as published by the Free Software Foundation; either
   7     version 2 of the License, or (at your option) any later version.
   8
   9     2004-01-15  INDI element is the most basic unit of the INDI KStars client.
  10  */
  11
  12 #ifndef INDIELEMENT_H
  13 #define INDIELEMENT_H
  14
  15 #include <kdialogbase.h>
  16 #include <unistd.h>
  17 #include <qstring.h>
  18 #include <qptrlist.h>
  19
  20 #include "indi/lilxml.h"
  21
  22 #define INDIVERSION     1.5     /* we support this or less */
  23
  24 /* GUI layout */
  25 #define PROPERTY_LABEL_WIDTH    80
  26 #define ELEMENT_LABEL_WIDTH     105
  27 #define ELEMENT_READ_WIDTH      150
  28 #define ELEMENT_WRITE_WIDTH     175
  29 #define ELEMENT_FULL_WIDTH      340
  30 #define BUTTON_WIDTH            101
  31 #define MIN_SET_WIDTH           50
  32 #define MAX_SET_WIDTH           110
  33
  34 // Pulse tracking
  35 #define INDI_PULSE_TRACKING   15000
  36
  37 /* decoded elements.
  38  * lights use PState, TB's use the alternate binary names.
  39  */
  40 typedef enum {PS_IDLE = 0, PS_OK, PS_BUSY, PS_ALERT, PS_N} PState;
  41 #define PS_OFF  PS_IDLE         /* alternate name */
  42 #define PS_ON   PS_OK           /* alternate name */
  43 typedef enum {PP_RW = 0, PP_WO, PP_RO} PPerm;
  44 typedef enum {PG_NONE = 0, PG_TEXT, PG_NUMERIC, PG_BUTTONS,
  45   PG_RADIO, PG_MENU, PG_LIGHTS, PG_BLOB} PGui;
  46
  47 /* INDI std properties */
  48 /* N.B. Need to modify corresponding entry in indidevice.cpp when changed */
  49 enum stdProperties { CONNECTION, EQUATORIAL_COORD, EQUATORIAL_EOD_COORD, ON_COORD_SET, ABORT_MOTION, SOLAR_SYSTEM,
  50                      GEOGRAPHIC_COORD, HORIZONTAL_COORD, TIME, EXPOSE_DURATION,
  51                      DEVICE_PORT, PARK, MOVEMENT, SDTIME, DATA_CHANNEL, VIDEO_STREAM, IMAGE_SIZE, FILTER_CONF};
  52
  53 /* Devices families that we explicity support (i.e. with std properties) */
  54 enum deviceFamily { KSTARS_TELESCOPE, KSTARS_CCD, KSTARS_FILTER, KSTARS_VIDEO, KSTARS_FOCUSER, KSTARS_DOME, KSTARS_GPS };
  55
  56 #define MAXSCSTEPS      1000    /* max number of steps in a scale */
  57 #define MAXRADIO        4       /* max numbere of buttons in a property */
  58
  59 /* Forward decleration */
  60 class KLed;
  61 class KLineEdit;
  62 class KDoubleSpinBox;
  63 class KPushButton;
  64 class KCheckBox;
  65 class KSqueezedTextLabel;
  66
  67 class QLabel;
  68 class QHBoxLayout;
  69 class QVBoxLayout;
  70 class QSpacerItem;
  71 class QCheckBox;
  72 class QSlider;
  73
  74 class INDI_P;
  75
  76 /* Useful XML functions */
  77 XMLAtt *   findAtt     (XMLEle *ep  , const char *name , char errmsg[]);
  78 XMLEle *   findEle     (XMLEle *ep  , INDI_P *pp, const char *child, char errmsg[]);
  79
  80 /* INDI Element */
  81 class INDI_E : public QObject
  82 {
  83  Q_OBJECT
  84  public:
  85   INDI_E(INDI_P *parentProperty, QString inName, QString inLabel);
  86   ~INDI_E();
  87     QString name;                       /*  name */
  88     QString label;                      /* label is the name by default, unless specefied */
  89     PState state;                       /* control on/off t/f etc */
  90     INDI_P *pp;                         /* parent property */
  91
  92     QHBoxLayout    *EHBox;              /* Horizontal layout */
  93
  94     /* GUI widgets, only malloced when needed */
  95     KSqueezedTextLabel *label_w;        // label
  96     KLineEdit      *read_w;             // read field
  97     KLineEdit      *write_w;            // write field
  98     KLed           *led_w;              // light led
  99     KDoubleSpinBox *spin_w;             // spinbox
 100     QSlider        *slider_w;           // Slider
 101     KPushButton    *push_w;             // push button
 102     KPushButton    *browse_w;           // browse button
 103     QCheckBox      *check_w;            // check box
 104     QSpacerItem    *hSpacer;            // Horizontal spacer
 105
 106     double min, max, step;              // params for scale
 107     double value;                       // current value
 108     double targetValue;                 // target value
 109     QString text;                       // current text
 110     QString format;                     // number format, if applicable
 111
 112    int buildTextGUI    (QString initText);
 113    int buildNumberGUI  (double initValue);
 114    int buildLightGUI();
 115    int buildBLOBGUI();
 116    void drawLt();
 117
 118    void initNumberValues(double newMin, double newMax, double newStep, char * newFormat);
 119    void updateValue(double newValue);
 120    void setMin (double inMin);
 121    void setMax (double inMax);
 122
 123    void setupElementLabel();
 124    void setupElementRead(int length);
 125    void setupElementWrite(int length);
 126    void setupElementScale(int length);
 127    void setupBrowseButton();
 128
 129    public slots:
 130    void spinChanged(double value);
 131    void sliderChanged(int value);
 132    void browseBlob();
 133
 134 };
 135
 136 #endif