kstars/kstars/indidevice.h

   1 /*  INDI Device
   2     Copyright (C) 2003 Jasem Mutlaq (mutlaqja@ikarustech.com)
   3                        Elwood C. Downey
   4
   5     This application is free software; you can redistribute it and/or
   6     modify it under the terms of the GNU General Public
   7     License as published by the Free Software Foundation; either
   8     version 2 of the License, or (at your option) any later version.
   9  */
  10
  11 #ifndef INDIDEVICE_H
  12 #define INDIDEVICE_H
  13
  14 #include <kdialogbase.h>
  15 #include <unistd.h>
  16 #include <qptrlist.h>
  17
  18 #include "indielement.h"
  19
  20 class DeviceManager;
  21 class INDI_D;
  22 class INDI_P;
  23 class INDI_G;
  24 class INDI_E;
  25 class INDIMenu;
  26 class INDIStdDevice;
  27 class SkyObject;
  28
  29 class KLed;
  30 class KLineEdit;
  31 class KComboBox;
  32 class KDoubleSpinBox;
  33 class KPushButton;
  34 class KPopupMenu;
  35
  36 class QTable;
  37 class QLabel;
  38 class QHBoxLayout;
  39 class QVBoxLayout;
  40 class QFrame;
  41 class QLineEdit;
  42 class QString;
  43 class QTextEdit;
  44 class QListView;
  45 class QTabWidget;
  46 class QSpacerItem;
  47 class QGridLayout;
  48 class QButtonGroup;
  49 class QCheckBox;
  50 class QScrollView;
  51 class QSocketNotifier;
  52 class QVBox;
  53
  54 /*************************************************************************
  55 ** The INDI Tree
  56 **
  57 ** INDI_ELEMENT <----------------------------------------
  58 **     |                                                |
  59 **     -----> INDI_PROPERTY                             |
  60 **                        |                             |
  61 **                        -----> INDI_GROUP             |
  62 **                                        |             |
  63 **                                        -----> INDI_DEVICE
  64 **                                               |         |
  65                                           Device Manager  INDI Menu
  66 **************************************************************************/
  67
  68
  69 /* INDI device */
  70 class INDI_D : public KDialogBase
  71 {
  72  Q_OBJECT
  73   public:
  74    INDI_D(INDIMenu *parentMenu, DeviceManager *parentManager, QString inName, QString inLabel);
  75    ~INDI_D();
  76
  77     QString     name;                   /* device name */
  78     QString     label;                  /* device label */
  79     QVBox       *deviceVBox;            /* device tab frame */
  80     QTabWidget  *groupContainer;        /* Groups within the device */
  81     QTextEdit   *msgST_w;               /* scrolled text for messages */
  82     unsigned char *dataBuffer;          /* Generic buffer */
  83     //QScrollView *sv;                  /* Scroll view */
  84     //QVBoxLayout *mainLayout;
  85     //QVBox       *propertyLayout;
  86     //QSpacerItem *vSpacer;
  87     //QSpacerItem *hSpacer;
  88
  89     //QPushButton  *clear;
  90     //QHBoxLayout  *buttonLayout;
  91     INDIStdDevice  *stdDev;
  92
  93     QPtrList<INDI_G> gl;                /* list of pointers to groups */
  94
  95     INDI_G        *curGroup;
  96     bool          INDIStdSupport;
  97
  98     INDIMenu      *parent;
  99     DeviceManager *parentMgr;
 100
 101     enum DTypes { DATA_FITS, DATA_STREAM, DATA_OTHER };
 102
 103    /*****************************************************************
 104    * Build
 105    ******************************************************************/
 106    int buildTextGUI    (XMLEle *root, char errmsg[]);
 107    int buildNumberGUI  (XMLEle *root, char errmsg[]);
 108    int buildSwitchesGUI(XMLEle *root, char errmsg[]);
 109    int buildMenuGUI    (INDI_P *pp, XMLEle *root, char errmsg[]);
 110    int buildLightsGUI  (XMLEle *root, char errmsg[]);
 111    int buildBLOBGUI    (XMLEle *root, char errmsg[]);
 112
 113    /*****************************************************************
 114    * Add
 115    ******************************************************************/
 116    INDI_P *  addProperty (XMLEle *root, char errmsg[]);
 117
 118    /*****************************************************************
 119    * Find
 120    ******************************************************************/
 121    INDI_P *   findProp    (QString name);
 122    INDI_E *   findElem    (QString name);
 123    INDI_G *   findGroup   (QString grouptag, int create, char errmsg[]);
 124    int        findPerm    (INDI_P *pp  , XMLEle *root, PPerm *permp, char errmsg[]);
 125
 126    /*****************************************************************
 127    * Set/New
 128    ******************************************************************/
 129    int setValue       (INDI_P *pp, XMLEle *root, char errmsg[]);
 130    int setLabelState  (INDI_P *pp, XMLEle *root, char errmsg[]);
 131    int setTextValue   (INDI_P *pp, XMLEle *root, char errmsg[]);
 132    int setBLOB        (INDI_P *pp, XMLEle * root, char errmsg[]);
 133
 134    int newValue       (INDI_P *pp, XMLEle *root, char errmsg[]);
 135    int newTextValue   (INDI_P *pp, XMLEle *root, char errmsg[]);
 136
 137    int setAnyCmd      (XMLEle *root, char errmsg[]);
 138    int newAnyCmd      (XMLEle *root, char errmsg[]);
 139
 140    int  removeProperty(INDI_P *pp);
 141
 142    /*****************************************************************
 143    * Crack
 144    ******************************************************************/
 145    int crackLightState  (char *name, PState *psp);
 146    int crackSwitchState (char *name, PState *psp);
 147
 148    /*****************************************************************
 149    * Data processing
 150    ******************************************************************/
 151    int processBlob(INDI_E *blobEL, XMLEle *ep, char errmsg[]);
 152
 153    /*****************************************************************
 154    * INDI standard property policy
 155    ******************************************************************/
 156    bool isOn();
 157    void registerProperty(INDI_P *pp);
 158    bool isINDIStd(INDI_P *pp);
 159
 160 };
 161
 162 #endif