USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::Tab Class Reference

A Tab is a QAction which shows or hides some other QWidget, which we call associatedWidget. More...

#include <Tab.h>

Inherits QAction.

List of all members.

Signals

void clicked (const int &)

Public Member Functions

 Tab (QWidget *associatedWidget, QWidget *parent=0)
 constructs a Tab
virtual ~Tab ()
 destructs a Tab
void setPosition (const int &newPosition)
 set the position of the Tab within a TabBar
const int & getPosition () const
 get the position of the Tab within a TabBar
void setRadioGroup (const int &newRadioGroup)
 Tabs which share a radio group have the property that only only one Tab in the group can be selected at a time.
const int & getRadioGroup () const
 Tabs which share a radio group have the property that only only one Tab in the group can be selected at a time.
void setSelected (bool newStatus)
 A selected Tab will look visually pressed and have its associatedWidget visible.
bool isSelected ()
 A selected Tab will look visually pressed and have its associatedWidget visible.

Detailed Description

A Tab is a QAction which shows or hides some other QWidget, which we call associatedWidget.

The Tab does not own this widget, it just stores a pointer so that it can set the widget to be visible or invisible. Tabs are toggleable. If a Tab is down then its associatedWidget is visible If a Tab is up then its associatedWidget is invisible. Tabs are designed to be added to TabBars, which are special QToolBars that can handle the management and storing of Tabs. Tabs have a "radioGroup" to which they belong, which is just an int. Tabs in the same TabBar which have the same radioGroup number have the property such that only one of the Tabs can be selected at a time. Note that the radioGroup value is only used if the TabBar for which the Tab resides has a radioStyle() of true, which is false by default. See TabBar for more details about radioStyle.

Author:
2010-05-06 Eric Hyer

Constructor & Destructor Documentation

Isis::Tab::Tab ( QWidget associatedWidget,
QWidget parent = 0 
)

constructs a Tab

References ASSERT_PTR.

Isis::Tab::~Tab (  )  [virtual]

destructs a Tab


Member Function Documentation

void Isis::Tab::clicked ( const int &  _t1  )  [signal]
const int & Isis::Tab::getPosition (  )  const

get the position of the Tab within a TabBar

const int & Isis::Tab::getRadioGroup (  )  const

Tabs which share a radio group have the property that only only one Tab in the group can be selected at a time.

Returns:
The radio group which this Tab belongs to
bool Isis::Tab::isSelected (  ) 

A selected Tab will look visually pressed and have its associatedWidget visible.

A Tab which is not selected will look like a normal button and its associatedWidget will be hidden.

Returns:
True if the Tab is selected, false otherwise
void Isis::Tab::setPosition ( const int &  newPosition  ) 

set the position of the Tab within a TabBar

Referenced by Isis::TabBar::addTab().

void Isis::Tab::setRadioGroup ( const int &  newRadioGroup  ) 

Tabs which share a radio group have the property that only only one Tab in the group can be selected at a time.

Parameters:
newRadioGroup The new radio group to which the Tab should belong
void Isis::Tab::setSelected ( bool  newStatus  ) 

A selected Tab will look visually pressed and have its associatedWidget visible.

A Tab which is not selected will look like a normal button and its associatedWidget will be hidden.

Parameters:
newStatus True if the Tab should be selected, false otherwise

References _FILEINFO_, Isis::iException::Message(), and Isis::iException::Programmer.

Referenced by Isis::TabBar::addTab().


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