git.sur5r.net Git - bacula/bacula/blob - bacula/src/qt-console/pages.cpp

   1 /*
   2    Bacula® - The Network Backup Solution
   3
   4    Copyright (C) 2007-2008 Free Software Foundation Europe e.V.
   5
   6    The main author of Bacula is Kern Sibbald, with contributions from
   7    many others, a complete list can be found in the file AUTHORS.
   8    This program is Free Software; you can redistribute it and/or
   9    modify it under the terms of version two of the GNU General Public
  10    License as published by the Free Software Foundation and included
  11    in the file LICENSE.
  12
  13    This program is distributed in the hope that it will be useful, but
  14    WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16    General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21    02110-1301, USA.
  22
  23    Bacula® is a registered trademark of John Walker.
  24    The licensor of Bacula is the Free Software Foundation Europe
  25    (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
  26    Switzerland, email:ftf@fsfeurope.org.
  27 */
  28 /*
  29  *   Version $Id$
  30  *
  31  *   Dirk Bartley, March 2007
  32  */
  33
  34 #include "pages.h"
  35 #include "bat.h"
  36
  37 /* A global function */
  38 bool isWin32Path(QString &fullPath)
  39 {
  40    char *buf = fullPath.left(2).toUtf8().data();
  41
  42    //bool toret = B_ISALPHA(buf[1]);
  43    bool toret = buf[1] == ':' && B_ISALPHA(buf[0]);
  44    if (mainWin->m_miscDebug) {
  45       if (toret)
  46          Pmsg1(000, "returning from isWin32Path true %s\n", fullPath.toUtf8().data());
  47       else
  48          Pmsg1(000, "returning from isWin32Path false %s\n", fullPath.toUtf8().data());
  49    }
  50    return toret;
  51 }
  52
  53
  54 /*
  55  * dockPage
  56  * This function is intended to be called from within the Pages class to pull
  57  * a window from floating to in the stack widget.
  58  */
  59
  60 void Pages::dockPage()
  61 {
  62    /* These two lines are for making sure if it is being changed from a window
  63     * that it has the proper window flag and parent.
  64     */
  65    setWindowFlags(Qt::Widget);
  66
  67    /* This was being done already */
  68    m_parent->addWidget(this);
  69
  70    /* Set docked flag */
  71    m_docked = true;
  72    mainWin->stackedWidget->setCurrentWidget(this);
  73    /* lets set the page selectors action for docking or undocking */
  74    setContextMenuDockText();
  75 }
  76
  77 /*
  78  * undockPage
  79  * This function is intended to be called from within the Pages class to put
  80  * a window from the stack widget to a floating window.
  81  */
  82
  83 void Pages::undockPage()
  84 {
  85    /* Change from a stacked widget to a normal window */
  86    m_parent->removeWidget(this);
  87    setWindowFlags(Qt::Window);
  88    show();
  89    /* Clear docked flag */
  90    m_docked = false;
  91    /* The window has been undocked, lets change the context menu */
  92    setContextMenuDockText();
  93 }
  94
  95 /*
  96  * This function is intended to be called with the subclasses.  When it is
  97  * called the specific sublclass does not have to be known to Pages.  When it
  98  * is called this function will change the page from it's current state of being
  99  * docked or undocked and change it to the other.
 100  */
 101
 102 void Pages::togglePageDocking()
 103 {
 104    if (m_docked) {
 105       undockPage();
 106    } else {
 107       dockPage();
 108    }
 109 }
 110
 111 /*
 112  * This function is because I wanted for some reason to keep it protected but still
 113  * give any subclasses the ability to find out if it is currently stacked or not.
 114  */
 115 bool Pages::isDocked()
 116 {
 117    return m_docked;
 118 }
 119
 120 /*
 121  * To keep m_closeable protected as well
 122  */
 123 bool Pages::isCloseable()
 124 {
 125    return m_closeable;
 126 }
 127
 128 /*
 129  * When a window is closed, this slot is called.  The idea is to put it back in the
 130  * stack here, and it works.  I wanted to get it to the top of the stack so that the
 131  * user immediately sees where his window went.  Also, if he undocks the window, then
 132  * closes it with the tree item highlighted, it may be confusing that the highlighted
 133  * treewidgetitem is not the stack item in the front.
 134  */
 135
 136 void Pages::closeEvent(QCloseEvent* event)
 137 {
 138    /* A Widget was closed, lets toggle it back into the window, and set it in front. */
 139    dockPage();
 140
 141    /* this fixes my woes of getting the widget to show up on top when closed */
 142    event->ignore();
 143
 144    /* Set the current tree widget item in the Page Selector window to the item
 145     * which represents "this"
 146     * Which will also bring "this" to the top of the stacked widget */
 147    setCurrent();
 148 }
 149
 150 /*
 151  * The next three are virtual functions.  The idea here is that each subclass will have the
 152  * built in virtual function to override if the programmer wants to populate the window
 153  * when it it is first clicked.
 154  */
 155 void Pages::PgSeltreeWidgetClicked()
 156 {
 157 }
 158
 159 /*
 160  *  Virtual function which is called when this page is visible on the stack.
 161  *  This will be overridden by classes that want to populate if they are on the
 162  *  top.
 163  */
 164 void Pages::currentStackItem()
 165 {
 166 }
 167
 168 /*
 169  * Function to close the stacked page and remove the widget from the
 170  * Page selector window
 171  */
 172 void Pages::closeStackPage()
 173 {
 174    /* First get the tree widget item and destroy it */
 175    QTreeWidgetItem *item=mainWin->getFromHash(this);
 176    /* remove the QTreeWidgetItem <-> page from the hash */
 177    mainWin->hashRemove(item, this);
 178    /* remove the item from the page selector by destroying it */
 179    delete item;
 180    /* remove this */
 181    delete this;
 182 }
 183
 184 /*
 185  * Function to set members from the external mainwin and it's overload being
 186  * passed a specific QTreeWidgetItem to be it's parent on the tree
 187  */
 188 void Pages::pgInitialize()
 189 {
 190    pgInitialize(NULL);
 191 }
 192
 193 void Pages::pgInitialize(QTreeWidgetItem *parentTreeWidgetItem)
 194 {
 195    m_parent = mainWin->stackedWidget;
 196    m_console = mainWin->currentConsole();
 197
 198    if (!parentTreeWidgetItem) {
 199       parentTreeWidgetItem = m_console->directorTreeItem();
 200    }
 201
 202    QTreeWidgetItem *item = new QTreeWidgetItem(parentTreeWidgetItem);
 203    QString name;
 204    treeWidgetName(name);
 205    item->setText(0, name);
 206    mainWin->hashInsert(item, this);
 207    setTitle();
 208 }
 209
 210 /*
 211  * Virtual Function to return a name
 212  * All subclasses should override this function
 213  */
 214 void Pages::treeWidgetName(QString &name)
 215 {
 216    name = m_name;
 217 }
 218
 219 /*
 220  * Function to simplify executing a console command and bringing the
 221  * console to the front of the stack
 222  */
 223 void Pages::consoleCommand(QString &command)
 224 {
 225    /*if (!m_console->is_connectedGui())
 226        return;*/
 227    if (!m_console->preventInUseConnect()) {
 228        return;
 229    }
 230    consoleInput(command);
 231 }
 232
 233 /*
 234  * Function to simplify executing a console command, but does not
 235  *  check for the connection in use.  We need this so that we can
 236  *  *always* enter command from the command line.
 237  */
 238 void Pages::consoleInput(QString &command)
 239 {
 240    /* Bring this director's console to the front of the stack */
 241    setConsoleCurrent();
 242    QString displayhtml("<font color=\"blue\">");
 243    displayhtml += command + "</font>\n";
 244    m_console->display_html(displayhtml);
 245    m_console->display_text("\n");
 246    m_console->write_dir(command.toUtf8().data());
 247    m_console->displayToPrompt();
 248 }
 249
 250 /*
 251  * Function for handling undocked windows becoming active.
 252  * Change the currently selected item in the page selector window to the now
 253  * active undocked window.  This will also make the console for the undocked
 254  * window m_currentConsole.
 255  */
 256 void Pages::changeEvent(QEvent *event)
 257 {
 258    if ((event->type() ==  QEvent::ActivationChange) && (isActiveWindow())) {
 259       setCurrent();
 260    }
 261 }
 262
 263 /*
 264  * Function to simplify getting the name of the class and the director into
 265  * the caption or title of the window
 266  */
 267 void Pages::setTitle()
 268 {
 269    QString wdgname, director;
 270    treeWidgetName(wdgname);
 271    m_console->getDirResName(director);
 272    QString title = tr("%1 of Director %2").arg(wdgname).arg(director);
 273    setWindowTitle(title);
 274 }
 275
 276 /*
 277  * Bring the current directors console window to the top of the stack.
 278  */
 279 void Pages::setConsoleCurrent()
 280 {
 281    mainWin->treeWidget->setCurrentItem(mainWin->getFromHash(m_console));
 282 }
 283
 284 /*
 285  * Bring this window to the top of the stack.
 286  */
 287 void Pages::setCurrent()
 288 {
 289    mainWin->treeWidget->setCurrentItem(mainWin->getFromHash(this));
 290 }
 291
 292 /*
 293  * Function to set the text of the toggle dock context menu when page and
 294  * widget item are NOT known.
 295  */
 296 void Pages::setContextMenuDockText()
 297 {
 298    QTreeWidgetItem *item = mainWin->getFromHash(this);
 299    QString docktext;
 300    if (isDocked()) {
 301       docktext = tr("UnDock %1 Window").arg(item->text(0));
 302    } else {
 303       docktext = tr("ReDock %1 Window").arg(item->text(0));
 304    }
 305
 306    mainWin->actionToggleDock->setText(docktext);
 307    setTreeWidgetItemDockColor();
 308 }
 309
 310 /*
 311  * Function to set the color of the tree widget item based on whether it is
 312  * docked or not.
 313  */
 314 void Pages::setTreeWidgetItemDockColor()
 315 {
 316    QTreeWidgetItem* item = mainWin->getFromHash(this);
 317    if (item) {
 318       if (item->text(0) != tr("Console")) {
 319          if (isDocked()) {
 320          /* Set the brush to blue if undocked */
 321             QBrush blackBrush(Qt::black);
 322             item->setForeground(0, blackBrush);
 323          } else {
 324          /* Set the brush back to black if docked */
 325             QBrush blueBrush(Qt::blue);
 326             item->setForeground(0, blueBrush);
 327          }
 328       }
 329    }
 330 }