workspace/kcontrol/hardware/joystick/joywidget.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2003 by Martin Koller                                   *
   3  *   m.koller@surfeu.at                                                    *
   4  *   This file is part of the KDE Control Center Module for Joysticks      *
   5  *                                                                         *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  *                                                                         *
  11  *   This program is distributed in the hope that it will be useful,       *
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  14  *   GNU General Public License for more details.                          *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU General Public License     *
  17  *   along with this program; if not, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  20  ***************************************************************************/
  21 #include "joywidget.h"
  22 #include "joydevice.h"
  23 #include "poswidget.h"
  24 #include "caldialog.h"
  25
  26 #include <QtGui/QTableWidget>
  27 #include <QLabel>
  28 #include <QCheckBox>
  29 #include <QTimer>
  30 #include <QFontMetrics>
  31 #include <QPushButton>
  32 #include <QHBoxLayout>
  33 #include <QVBoxLayout>
  34 #include <QHeaderView>
  35
  36 #include <klocale.h>
  37 #include <kdialog.h>
  38 #include <kmessagebox.h>
  39 #include <kiconloader.h>
  40 #include <kcombobox.h>
  41 #include <kurlcompletion.h>
  42
  43 #include <stdio.h>
  44 #include <kvbox.h>
  45 #include <kdebug.h>
  46 //--------------------------------------------------------------
  47 static QString PRESSED = I18N_NOOP("PRESSED");
  48 //--------------------------------------------------------------
  49
  50 class TableWidget : public QTableWidget
  51 {
  52   public:
  53     TableWidget(int row, int col) : QTableWidget(row, col) {}
  54
  55     virtual QSize sizeHint() const
  56     {
  57       return QSize(150, 100);  // return a smaller size than the Qt default(256, 192)
  58     }
  59 };
  60
  61 //--------------------------------------------------------------
  62
  63 JoyWidget::JoyWidget(QWidget *parent)
  64  : QWidget(parent), idle(0), joydev(0)
  65 {
  66   QVBoxLayout *mainVbox = new QVBoxLayout(this);
  67   mainVbox->setSpacing(KDialog::spacingHint());
  68   mainVbox->setMargin(0);
  69
  70   // create area to show an icon + message if no joystick was detected
  71   {
  72     messageBox = new QFrame(this);
  73     messageBox->setFrameStyle(QFrame::StyledPanel);
  74     QHBoxLayout *box = new QHBoxLayout(messageBox);
  75     box->setSpacing(KDialog::spacingHint());
  76
  77     QLabel *icon = new QLabel(messageBox);
  78     icon->setPixmap(KIconLoader::global()->loadIcon("dialog-warning", KIconLoader::NoGroup,
  79                                                     KIconLoader::SizeMedium, KIconLoader::DefaultState, QStringList(), 0, true));
  80     icon->setFixedSize(icon->sizeHint());
  81     message = new QLabel(messageBox);
  82
  83     box->addWidget(icon);
  84     box->addWidget(message);
  85
  86     messageBox->hide();
  87
  88     mainVbox->addWidget(messageBox);
  89   }
  90
  91   QHBoxLayout *devHbox = new QHBoxLayout;
  92   devHbox->setSpacing(KDialog::spacingHint());
  93   devHbox->addWidget(new QLabel(i18n("Device:")));
  94   devHbox->addWidget(device = new KComboBox(true));
  95
  96   device->setInsertPolicy(QComboBox::NoInsert);
  97   KUrlCompletion *kc = new KUrlCompletion(KUrlCompletion::FileCompletion);
  98   device->setCompletionObject(kc);
  99   device->setAutoDeleteCompletionObject(true);
 100   connect(device, SIGNAL(activated(const QString &)), this, SLOT(deviceChanged(const QString &)));
 101   connect(device, SIGNAL(returnPressed(const QString &)), this, SLOT(deviceChanged(const QString &)));
 102   devHbox->setStretchFactor(device, 3);
 103
 104   QHBoxLayout *hbox = new QHBoxLayout;
 105   hbox->setSpacing(KDialog::spacingHint());
 106
 107   mainVbox->addLayout(devHbox);
 108   mainVbox->addLayout(hbox);
 109
 110   QVBoxLayout *vboxLeft = new QVBoxLayout;
 111   vboxLeft->setSpacing(KDialog::spacingHint());
 112   vboxLeft->addWidget(new QLabel(i18nc("Cue for deflection of the stick", "Position:")));
 113   vboxLeft->addWidget(xyPos = new PosWidget);
 114
 115   mainVbox->addWidget(trace = new QCheckBox(i18n("Show trace")));
 116   connect(trace, SIGNAL(toggled(bool)), this, SLOT(traceChanged(bool)));
 117
 118   QVBoxLayout *vboxMid = new QVBoxLayout;
 119   vboxMid->setSpacing(KDialog::spacingHint());
 120
 121   QVBoxLayout *vboxRight = new QVBoxLayout;
 122   vboxRight->setSpacing(KDialog::spacingHint());
 123
 124   // calculate the column width we need
 125   QFontMetrics fm(font());
 126   int colWidth = qMax(fm.width(PRESSED), fm.width("-32767")) + 10;  // -32767 largest string
 127
 128   vboxMid->addWidget(new QLabel(i18n("Buttons:")));
 129   buttonTbl = new TableWidget(0, 1);
 130   buttonTbl->setSelectionMode(QAbstractItemView::NoSelection);
 131   buttonTbl->setEditTriggers(QAbstractItemView::NoEditTriggers);
 132   buttonTbl->setHorizontalHeaderLabels(QStringList(i18n("State")));
 133   buttonTbl->setSortingEnabled(false);
 134   buttonTbl->horizontalHeader()->setClickable(false);
 135   buttonTbl->horizontalHeader()->setResizeMode(QHeaderView::Stretch);
 136   buttonTbl->horizontalHeader()->resizeSection(0, colWidth);
 137   buttonTbl->verticalHeader()->setClickable(false);
 138   vboxMid->addWidget(buttonTbl);
 139
 140   vboxRight->addWidget(new QLabel(i18n("Axes:")));
 141   axesTbl = new TableWidget(0, 1);
 142   axesTbl->setSelectionMode(QAbstractItemView::NoSelection);
 143   axesTbl->setEditTriggers(QAbstractItemView::NoEditTriggers);
 144   axesTbl->setHorizontalHeaderLabels(QStringList(i18n("Value")));
 145   axesTbl->setSortingEnabled(false);
 146   axesTbl->horizontalHeader()->setClickable(false);
 147   axesTbl->horizontalHeader()->setResizeMode(QHeaderView::Stretch);
 148   axesTbl->horizontalHeader()->resizeSection(0, colWidth);
 149   axesTbl->verticalHeader()->setClickable(false);
 150   vboxRight->addWidget(axesTbl);
 151
 152   hbox->addLayout(vboxLeft);
 153   hbox->addLayout(vboxMid);
 154   hbox->addLayout(vboxRight);
 155
 156   // calibrate button
 157   calibrate = new QPushButton(i18n("Calibrate"));
 158   connect(calibrate, SIGNAL(clicked()), this, SLOT(calibrateDevice()));
 159   calibrate->setEnabled(false);
 160
 161   mainVbox->addWidget(calibrate);
 162   mainVbox->addStretch();
 163
 164   // set up a timer for idle processing of joystick events
 165   idle = new QTimer(this);
 166   connect(idle, SIGNAL(timeout()), this, SLOT(checkDevice()));
 167
 168   // check which devicefiles we have
 169   init();
 170 }
 171
 172 //--------------------------------------------------------------
 173
 174 JoyWidget::~JoyWidget()
 175 {
 176   delete joydev;
 177 }
 178
 179 //--------------------------------------------------------------
 180
 181 void JoyWidget::init()
 182 {
 183   // check which devicefiles we have
 184   int i;
 185   bool first = true;
 186   char dev[30];
 187
 188   device->clear();
 189   buttonTbl->setRowCount(0);
 190   axesTbl->setRowCount(0);
 191
 192   for (i = 0; i < 5; i++)  // check the first 5 devices
 193   {
 194     sprintf(dev, "/dev/js%d", i);  // first look in /dev
 195     JoyDevice *joy = new JoyDevice(dev);
 196
 197     if ( joy->open() != JoyDevice::SUCCESS )
 198     {
 199       delete joy;
 200       sprintf(dev, "/dev/input/js%d", i);  // then look in /dev/input
 201       joy = new JoyDevice(dev);
 202
 203       if ( joy->open() != JoyDevice::SUCCESS )
 204       {
 205         delete joy;
 206         continue;    // try next number
 207       }
 208     }
 209
 210     // we found one
 211
 212     device->addItem(QString("%1 (%2)").arg(joy->text()).arg(joy->device()));
 213
 214     // display values for first device
 215     if ( first )
 216     {
 217       showDeviceProps(joy);  // this sets the joy object into this->joydev
 218       first = false;
 219     }
 220     else
 221       delete joy;
 222   }
 223
 224   /* KDE 4: Remove this check(and i18n) when all KCM wrappers properly test modules */
 225   if ( device->count() == 0 )
 226   {
 227     messageBox->show();
 228     message->setText(QString("<qt><b>%1</b></qt>").arg(
 229       i18n("No joystick device automatically found on this computer.<br />"
 230            "Checks were done in /dev/js[0-4] and /dev/input/js[0-4]<br />"
 231            "If you know that there is one attached, please enter the correct device file.")));
 232   }
 233 }
 234
 235 //--------------------------------------------------------------
 236
 237 void JoyWidget::traceChanged(bool state)
 238 {
 239   xyPos->showTrace(state);
 240 }
 241
 242 //--------------------------------------------------------------
 243
 244 void JoyWidget::restoreCurrDev()
 245 {
 246   if ( !joydev )  // no device open
 247   {
 248     device->setEditText("");
 249     calibrate->setEnabled(false);
 250   }
 251   else
 252   {
 253     // try to find the current open device in the combobox list
 254     int index = device->findText(joydev->device(), Qt::MatchContains);
 255
 256     if ( index == -1 )  // the current open device is one the user entered (not in the list)
 257       device->setEditText(joydev->device());
 258     else
 259       device->setEditText(device->itemText(index));
 260   }
 261 }
 262
 263 //--------------------------------------------------------------
 264
 265 void JoyWidget::deviceChanged(const QString &dev)
 266 {
 267   // find "/dev" in given string
 268   int start, stop;
 269   QString devName;
 270
 271   if ( (start = dev.indexOf("/dev")) == -1 )
 272   {
 273     KMessageBox::sorry(this,
 274       i18n("The given device name is invalid (does not contain /dev).\n"
 275            "Please select a device from the list or\n"
 276            "enter a device file, like /dev/js0."), i18n("Unknown Device"));
 277
 278     restoreCurrDev();
 279     return;
 280   }
 281
 282   if ( (stop = dev.indexOf(")", start)) != -1 )  // seems to be text selected from our list
 283     devName = dev.mid(start, stop - start);
 284   else
 285     devName = dev.mid(start);
 286
 287   if ( joydev && (devName == joydev->device()) ) return;  // user selected the current device; ignore it
 288
 289   JoyDevice *joy = new JoyDevice(devName);
 290   JoyDevice::ErrorCode ret = joy->open();
 291
 292   if ( ret != JoyDevice::SUCCESS )
 293   {
 294     KMessageBox::error(this, joy->errText(ret), i18n("Device Error"));
 295
 296     delete joy;
 297     restoreCurrDev();
 298     return;
 299   }
 300
 301   showDeviceProps(joy);
 302 }
 303
 304 //--------------------------------------------------------------
 305
 306 void JoyWidget::showDeviceProps(JoyDevice *joy)
 307 {
 308   joydev = joy;
 309
 310   buttonTbl->setRowCount(joydev->numButtons());
 311
 312   axesTbl->setRowCount(joydev->numAxes());
 313   if ( joydev->numAxes() >= 2 )
 314   {
 315     axesTbl->setVerticalHeaderItem(0, new QTableWidgetItem(i18n("1(x)")));
 316     axesTbl->setVerticalHeaderItem(1, new QTableWidgetItem(i18n("2(y)")));
 317   }
 318
 319   calibrate->setEnabled(true);
 320   idle->start(0);
 321
 322   // make both tables use the same space for header; this looks nicer
 323   // TODO: Don't know how to do this in Qt4; the following does no longer work
 324   // Probably by setting a sizeHint for every single header item ?
 325   /*
 326   buttonTbl->verticalHeader()->setFixedWidth(qMax(buttonTbl->verticalHeader()->width(),
 327                                                     axesTbl->verticalHeader()->width()));
 328   axesTbl->verticalHeader()->setFixedWidth(buttonTbl->verticalHeader()->width());
 329   */
 330 }
 331
 332 //--------------------------------------------------------------
 333
 334 void JoyWidget::checkDevice()
 335 {
 336   if ( !joydev ) return;  // no open device yet
 337
 338   JoyDevice::EventType type;
 339   int number, value;
 340
 341   if ( !joydev->getEvent(type, number, value) )
 342     return;
 343
 344   if ( type == JoyDevice::BUTTON )
 345   {
 346     if ( ! buttonTbl->item(number, 0) )
 347       buttonTbl->setItem(number, 0, new QTableWidgetItem());
 348
 349     if ( value == 0 )  // button release
 350       buttonTbl->item(number, 0)->setText("-");
 351     else
 352       buttonTbl->item(number, 0)->setText(PRESSED);
 353   }
 354
 355   if ( type == JoyDevice::AXIS )
 356   {
 357     if ( number == 0 ) // x-axis
 358       xyPos->changeX(value);
 359
 360     if ( number == 1 ) // y-axis
 361       xyPos->changeY(value);
 362
 363     if ( ! axesTbl->item(number, 0) )
 364       axesTbl->setItem(number, 0, new QTableWidgetItem());
 365
 366     axesTbl->item(number, 0)->setText(QString("%1").arg(int(value)));
 367   }
 368 }
 369
 370 //--------------------------------------------------------------
 371
 372 void JoyWidget::calibrateDevice()
 373 {
 374   if ( !joydev ) return;  // just to be save
 375
 376   JoyDevice::ErrorCode ret = joydev->initCalibration();
 377
 378   if ( ret != JoyDevice::SUCCESS )
 379   {
 380     KMessageBox::error(this, joydev->errText(ret), i18n("Communication Error"));
 381     return;
 382   }
 383
 384   if ( KMessageBox::messageBox(this, KMessageBox::Information,
 385         i18n("<qt>Calibration is about to check the precision.<br /><br />"
 386              "<b>Please move all axes to their center position and then "
 387              "do not touch the joystick anymore.</b><br /><br />"
 388              "Click OK to start the calibration.</qt>"),
 389         i18n("Calibration"),
 390         KStandardGuiItem::ok(), KStandardGuiItem::cancel()) != KMessageBox::Ok )
 391     return;
 392
 393   idle->stop();  // stop the joystick event getting; this must be done inside the calibrate dialog
 394
 395   CalDialog dlg(this, joydev);
 396   dlg.calibrate();
 397
 398   // user canceled somewhere during calibration, therefore the device is in a bad state
 399   if ( dlg.result() == QDialog::Rejected )
 400     joydev->restoreCorr();
 401
 402   idle->start(0);  // continue with event getting
 403 }
 404
 405 //--------------------------------------------------------------
 406
 407 void JoyWidget::resetCalibration()
 408 {
 409   if ( !joydev ) return;  // just to be save
 410
 411   JoyDevice::ErrorCode ret = joydev->restoreCorr();
 412
 413   if ( ret != JoyDevice::SUCCESS )
 414   {
 415     KMessageBox::error(this, joydev->errText(ret), i18n("Communication Error"));
 416   }
 417   else
 418   {
 419     KMessageBox::information(this,
 420       i18n("Restored all calibration values for joystick device %1.", joydev->device()),
 421       i18n("Calibration Success"));
 422   }
 423 }
 424
 425 //--------------------------------------------------------------
 426
 427 #include "joywidget.moc"