gui::SelectTool Class Reference

Toolbar widget for selecting arbitrary text. More...

#include <selecttool.h>

List of all members.

Signals

void clicked (const QString &name)
void helpText (const QString &message)

Public Member Functions

 SelectTool (const QString &cName, QWidget *parent=0, const char *name=NULL)
 ~SelectTool ()
QSize sizeHint () const
QString getName () const
void setPredefs (const QString &predefs, const QString &separator=",")
void setPredefs (const QStringList &predefs)
QString getText () const
void setText (const QString &newText)
void setTooltip (const QString &t)

Protected Slots

void textEntered (const QString &str)

Protected Member Functions

virtual void resizeEvent (QResizeEvent *e)
virtual void enterEvent (QEvent *e)
virtual void leaveEvent (QEvent *e)

Protected Attributes

QComboBox * ed
QString text
QString textName
QStringList choices
QString tip

Detailed Description

Toolbar widget for selecting arbitrary text.

Toolbutton allowing to select text from list of predefined values Scripts can read/write the text when needed Can be placed in toolbar in place of ordinary button

Constructor & Destructor Documentation

gui::SelectTool::SelectTool ( const QString &  cName,
QWidget *  parent = 0,
const char *  name = NULL 
)

Default constructor of SelectTool

Parameters:
parent Toolbar containing this control
name Name of this widget (passed to QWidget constructor)
cName name of text in this widget

References ed, helpText(), text, textEntered(), and textName.

gui::SelectTool::~SelectTool (  ) 

default destructor

Member Function Documentation

void gui::SelectTool::clicked ( const QString &  name  )  [signal]

Signal emitted when user changes the text

Parameters:
name Name of the text tool

Referenced by textEntered().

void gui::SelectTool::enterEvent ( QEvent *  e  )  [protected, virtual]

Event handler for mouse cursor entering tool. Sends its tooltip as help text.

Parameters:
e Event

References helpText(), and tip.

QString gui::SelectTool::getName (  )  const

Return name of the text edit box

References textName.

QString gui::SelectTool::getText (  )  const

Return text inside this control

References text.

void gui::SelectTool::helpText ( const QString &  message  )  [signal]

Send help message when mouse cursor enters/leaves the button. Help message is sent on enter and QString::null on leave.

Parameters:
message Help message

Referenced by enterEvent(), leaveEvent(), and SelectTool().

void gui::SelectTool::leaveEvent ( QEvent *  e  )  [protected, virtual]

Event handler for mouse cursor leaving tool. Sends empty helptext, thus disabling it

Parameters:
e Event

References helpText().

void gui::SelectTool::resizeEvent ( QResizeEvent *  e  )  [protected, virtual]

Called on resizing of property editing control Will simply set the same fixed size to inner editbox

Parameters:
e resize event

References ed.

void gui::SelectTool::setPredefs ( const QStringList &  predefs  ) 

Set list of predefined values

Parameters:
predefs List of predefined values for quick selecting

References choices, ed, setText(), and text.

void gui::SelectTool::setPredefs ( const QString &  predefs,
const QString &  separator = "," 
)

Set list of predefined values

Parameters:
predefs List of predefined values for quick selecting
separator separator of values in list, by default comma
void gui::SelectTool::setText ( const QString &  newText  ) 

Set text inside this control

Parameters:
newText new text to set

References choices, ed, and text.

Referenced by setPredefs().

void gui::SelectTool::setTooltip ( const QString &  t  ) 

Set tooltip to be show for this tool

Parameters:
t text to be used as tooltip

References tip.

QSize gui::SelectTool::sizeHint (  )  const

Return size hint of this control

Returns:
size hint

References ed.

void gui::SelectTool::textEntered ( const QString &  str  )  [protected, slot]

Called whenever text in the control changes

Parameters:
str New text

References clicked(), text, and textName.

Referenced by SelectTool().

Member Data Documentation

QStringList gui::SelectTool::choices [protected]

Allowed choices

Referenced by setPredefs(), and setText().

QComboBox* gui::SelectTool::ed [protected]

combo box or line edit for the text

Referenced by resizeEvent(), SelectTool(), setPredefs(), setText(), and sizeHint().

QString gui::SelectTool::text [protected]

Text typed in the tool

Referenced by getText(), SelectTool(), setPredefs(), setText(), and textEntered().

QString gui::SelectTool::textName [protected]

Name of text in this widget

Referenced by getName(), SelectTool(), and textEntered().

QString gui::SelectTool::tip [protected]

Tooltip for this selectbox

Referenced by enterEvent(), and setTooltip().

The documentation for this class was generated from the following files: