Commit a00c0b35 authored by Sebastian Eichelbaum's avatar Sebastian Eichelbaum
Browse files

[DOC]

parent fea00bf0
......@@ -117,6 +117,11 @@ public:
*/
const WBoolFlag& isInitialized() const;
/**
* Returns the signal used for pick events.
*
* \return the signal fired on pick events.
*/
boost::signals2::signal1< void, std::string >* getPickSignal();
protected:
......@@ -244,6 +249,9 @@ private:
*/
WBoolFlag m_isInitialized;
/**
* The signal used for picking events inside this widget.
*/
boost::signals2::signal1<void, std::string > m_pickSignal;
};
......
......@@ -49,17 +49,21 @@ public:
explicit WQtNavGLWidget( QString title, QWidget* parent, int maxValue = 100, std::string sliderTitle="pos" );
/**
* destructor
* destructor.
*/
virtual ~WQtNavGLWidget();
/**
* Gets the contained GL widget instance.
*
* \return pointer to GL widget
*/
boost::shared_ptr<WQtGLWidget>getGLWidget();
boost::shared_ptr< WQtGLWidget > getGLWidget();
/**
* Set the title of the slider used in this nav widget
*
* \param title the title
*/
void setSliderTitle( std::string title );
......@@ -73,6 +77,10 @@ protected:
virtual void closeEvent( QCloseEvent* event );
private:
/**
* The slider's title.
*/
QString m_sliderTitle;
/**
......@@ -81,9 +89,22 @@ private:
boost::shared_ptr<WQtGLWidget> m_glWidget;
private slots:
/**
* Slot getting called whenever the slider gets moved.
*
* \param value the new value of the slider.
*/
void sliderValueChanged( int value );
signals:
/**
* Signals a value change event inside the slider.
*
* \param name name of the slider.
* \param value value of the slider.
*/
void navSliderValueChanged( QString name, int value );
};
......
......@@ -41,7 +41,7 @@
/**
* container widget to contain the context widget for the dataset browser
* Container widget to contain the context widget for the dataset browser.
*/
class WQtDSBWidget : public QWidget
{
......@@ -101,8 +101,6 @@ public:
*/
void addSpacer();
/**
* getter for m_name
*/
......@@ -110,8 +108,20 @@ public:
protected:
private:
/**
* The name used for this widget.
*/
QString m_name;
/**
* Layout used for each "widget combination".
*/
QGridLayout m_controlLayout;
/**
* Layout used for the whole widget.
*/
QVBoxLayout m_pageLayout;
};
......
......@@ -40,7 +40,7 @@ public:
/**
* standard constructor
*/
explicit WQtLineEdit();
WQtLineEdit();
/**
* destructor
......@@ -48,18 +48,34 @@ public:
virtual ~WQtLineEdit();
/**
* setter for name
* Setter for name.
*
* \param name the new name for the line edit
*/
void setName( QString name );
private:
/**
* Name of the edit and its value.
*/
QString m_name;
public slots:
/**
* Value of the edit field changed.
*/
void emitStateChanged();
signals:
/**
* Signal a state change in the line edit.
*
* \param name name of the line edit.
* \param text new text inside the edit field.
*/
void lineEditStateChanged( QString name, QString text );
};
......
......@@ -38,7 +38,8 @@ class WQtNumberEdit : public QLineEdit
public:
/**
* default constructor
* Default constructor
*
* \param parent The parent widget of this widget, i.e. the widget that manages it.
*/
explicit WQtNumberEdit( QWidget* parent = 0 );
......@@ -49,16 +50,27 @@ public:
virtual ~WQtNumberEdit();
public slots:
/**
* Set the value of the number edit.
*
* \param number the new number of the number edit.
*/
void setInt( int number );
/**
* Slot getting called whenever the value of the edit changed.
*/
void numberChanged();
signals:
void signalNumber( int );
/**
* Signals a new value of the edit
*
* \param value the new value.
*/
void signalNumber( int value );
protected:
private:
......
......@@ -38,27 +38,30 @@ class WQtNumberEditDouble : public QLineEdit
public:
/**
* Default constructor, that connects the slot of the edit
* Default constructor, that connects the slot of the edit.
*
* \param name The name of teh widget
* \param parent The widget managing this widget
*/
explicit WQtNumberEditDouble( QString name, QWidget* parent = 0 );
/**
* setter for name
* setter for name.
*
* \param name The new name for the widget
*/
void setName( QString name );
/**
* destructor
*/
virtual ~WQtNumberEditDouble();
public slots:
/**
* Sets the edit field to a certain number.
*
* \param number The double to be put into the field.
*/
void setDouble( double number );
......@@ -69,13 +72,20 @@ public slots:
void numberChanged();
signals:
/**
* Signal to distribute the number set in the lineEdit.
*
* \param name name of the edit field.
* \param number new value of the edit field.
*/
void signalNumberWithName( QString name, double number );
protected:
private:
/**
* Name if the value.
*/
QString m_name;
};
......
......@@ -52,36 +52,40 @@ public:
virtual ~WQtSliderWithEdit();
/**
* setter for name
* \param name the new name for the GUI element.wo bin ich? hilfe! ich will hier raus
* Setter for name.
*
* \param name the new name for the GUI element.
*/
void setName( QString name );
/**
* setter for min value
* \param min the new minimum value
* Setter for min value.
*
* \param min the new minimum value.
*/
void setMin( int min );
/**
* setter for max value
* \param max the new maximum value
* Setter for max value.
*
* \param max the new maximum value.
*/
void setMax( int max );
/**
* setter for current value
* \param value the new current value
* Setter for current value.
*
* \param value the new current value.
*/
void setValue( int value );
public slots:
/**
* emits the slider value to the outside world
*/
void emitValue();
protected:
private:
QSlider m_slider; //!< The slider of this GUI element;
......@@ -91,6 +95,12 @@ private:
QString m_name; //!< The name of this gui element.
signals:
/**
* Signal to propagate the value of the slider.
*
* \param name name of the slider
* \param number actual value
*/
void signalNumberWithName( QString name, int number );
};
......
......@@ -76,6 +76,9 @@ protected:
private:
/**
* The module represented by this tree item.
*/
boost::shared_ptr< WModule > m_module;
};
......
......@@ -30,7 +30,7 @@
#include <QtGui/QPushButton>
/**
* implements a QPushButton with a boost signal
* Implements a QPushButton with a boost signal for convenience.
*/
class WQtPushButton : public QPushButton
{
......@@ -50,7 +50,8 @@ public:
virtual ~WQtPushButton();
/**
* setter for name
* Setter for name.
*
* \param name The new name of the button
*/
void setName( QString name );
......@@ -62,15 +63,32 @@ public:
*/
QString getName();
private:
QString m_name; //!< name of the push button
public slots:
/**
* Slot getting called when the button got pressed.
*/
void emitPressed();
signals:
/**
* Signal whenever the button got pressed.
*
* \param name the name of the button.
*/
void pushButtonPressed( QString name );
/**
* Signals whenever the button got toggled.
*
* \param name the name of the button.
* \param value true if toggled.
*/
void pushButtonToggled( QString name, bool value );
};
......
......@@ -33,7 +33,7 @@
#include "../guiElements/WQtPushButton.h"
/**
* TODO(schurade): Document this!
* This class represents a menu page inside the ribbon menu. It offers several methods to add buttons and manage the menu.
*/
class WQtMenuPage : public QWidget
{
......@@ -47,12 +47,14 @@ public:
WQtMenuPage( QString name, bool persistent = true );
/**
* TODO(schurade): Document this!
* Destructor.
*/
virtual ~WQtMenuPage();
/**
* Add a new button to this menu page in the ribbon menu.
*
* \param button the new button to add
*/
void addButton( WQtPushButton* button );
......@@ -64,7 +66,9 @@ public:
std::vector< QString > getButtons();
/**
* Returns the name of the tab
* Returns the name of the tab.
*
* \return the name of this menu page.
*/
QString getName();
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment