Developer Documentation

StatusbarInterface.hh
Go to the documentation of this file.
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42 #pragma once
43
44 #include <OpenFlipper/common/Types.hh>
45
46 #include <QWidget>
47
48
57 namespace ApplicationStatus {
58
64 enum applicationStatus {
65 READY,
66 PROCESSING,
67 BLOCKED
68 };
69
70 }
71
72
81 class StatusbarInterface {
82
83 private slots :
84
85 public :
86
88 virtual ~StatusbarInterface() {};
89
90 signals :
91
97 virtual void showStatusMessage(QString _message, int _timeout = 0) {};
98
99
107 void setStatus( ApplicationStatus::applicationStatus _status) {};
108
112 void clearStatusMessage() {};
113
121 void addWidgetToStatusbar(QWidget* _widget) {};
122
123 };
124
125
182 Q_DECLARE_INTERFACE(StatusbarInterface,"OpenFlipper.StatusbarInterface/1.0")
183
ApplicationStatus::READY
Status is ready (green light)
Definition: StatusbarInterface.hh:65
ApplicationStatus::BLOCKED
Status is processing and blocked system will not allow interaction (red light)
Definition: StatusbarInterface.hh:67
StatusbarInterface
Control OpenFlippers status bar.
Definition: StatusbarInterface.hh:81
StatusbarInterface::clearStatusMessage
void clearStatusMessage()
Removes the current message from the statusBar.
Definition: StatusbarInterface.hh:112
ApplicationStatus
Definition: StatusbarInterface.hh:57
StatusbarInterface::setStatus
void setStatus(ApplicationStatus::applicationStatus _status)
Sets the status icon of the StatusBar.
Definition: StatusbarInterface.hh:107
ApplicationStatus::applicationStatus
applicationStatus
Enum for the statusBar Status Icon.
Definition: StatusbarInterface.hh:64
ApplicationStatus::PROCESSING
Status is processing but system will allow interaction (yellow light)
Definition: StatusbarInterface.hh:66
StatusbarInterface::addWidgetToStatusbar
void addWidgetToStatusbar(QWidget *_widget)
Add a widget on the right side of the statusBar.
Definition: StatusbarInterface.hh:121
Types.hh
StatusbarInterface::~StatusbarInterface
virtual ~StatusbarInterface()
Destructor.
Definition: StatusbarInterface.hh:88
StatusbarInterface::showStatusMessage
virtual void showStatusMessage(QString _message, int _timeout=0)
Show a message in the status bar.
Definition: StatusbarInterface.hh:97