SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
smtk::extension::qtBaseView Class Reference

A base class for all view types implemented using Qt. More...

#include <qtBaseView.h>

Inheritance diagram for smtk::extension::qtBaseView:
[legend]
Collaboration diagram for smtk::extension::qtBaseView:
[legend]

Public Slots

virtual void updateUI ()
 Have the view update its contents. More...
 
virtual void childrenResized ()
 
virtual void showAdvanceLevelOverlay (bool val)
 
virtual void showAdvanceLevel (int)
 Have the view update its contents based on a new advance level.
 
virtual void enableShowBy (int)
 
virtual void onInfo ()
 Display view information (i.e., help text)
 
virtual void onShowCategory ()
 

Signals

void aboutToDestroy ()
 
void modified ()
 

Public Member Functions

 smtkTypenameMacro (qtBaseView)
 
 qtBaseView (const smtk::view::Information &info)
 
const smtk::view::ConfigurationPtrconfiguration () const
 
QWidget * widget () const
 
QWidget * parentWidget () const
 
qtUIManageruiManager () const
 
virtual int advanceLevel () const
 
virtual bool categoryEnabled () const
 
virtual std::string currentCategory () const
 
virtual void setInitialCategory ()
 When category filtering is requested to be either on by default or is requested to be on permanently, we need to have a mechanism to force the views to display info based on the initial category. More...
 
bool isTopLevel () const
 
virtual bool isEmpty () const
 Return true if the view does not contain any information to display. More...
 
virtual bool isValid () const
 Return true if the view's contents are valid.
 
- Public Member Functions inherited from smtk::view::BaseView
 smtkTypenameMacroBase (BaseView)
 
virtual std::size_t index () const
 index is a compile-time intrinsic of the derived view; as such, it cannot be set.
 

Static Public Member Functions

static bool validateInformation (const smtk::view::Information &info)
 

Protected Member Functions

virtual void buildUI ()
 Creates the UI related to the view and properly assigns it to the parent widget.
 
virtual void createWidget ()
 Creates the main QT Widget that is associated with a View. More...
 
virtual void makeTopLevel ()
 Adds properties associated with respects to a top level view.
 
virtual void setInfoToBeDisplayed ()
 Set the information to be displayed in the ViewInfoDialog.
 

Protected Attributes

QWidget * Widget
 
bool m_isTopLevel
 
bool m_useSelectionManager
 
smtk::view::Information m_viewInfo
 
QPointer< qtViewInfoDialogm_infoDialog
 
bool m_advOverlayVisible
 

Friends

class qtUIManager
 

Detailed Description

A base class for all view types implemented using Qt.

Member Function Documentation

◆ createWidget()

virtual void smtk::extension::qtBaseView::createWidget ( )
inlineprotectedvirtual

◆ isEmpty()

virtual bool smtk::extension::qtBaseView::isEmpty ( ) const
inlinevirtual

Return true if the view does not contain any information to display.

Subclasses should override this method and return false by default unless they have specific knowledge that the view is vacuous.

Reimplemented in smtk::extension::qtOperationPalette, smtk::extension::qtComponentAttributeView, smtk::extension::qtSelectorView, smtk::extension::qtBaseAttributeView, smtk::extension::qtAssociationView, smtk::extension::qtAttributeView, smtk::extension::qtInstancedView, and smtk::extension::qtGroupView.

◆ setInitialCategory()

virtual void smtk::extension::qtBaseView::setInitialCategory ( )
inlinevirtual

When category filtering is requested to be either on by default or is requested to be on permanently, we need to have a mechanism to force the views to display info based on the initial category.

This method will check to see if this is the case and call the onShowCategory method

Reimplemented in smtk::extension::qtBaseAttributeView.

◆ updateUI

virtual void smtk::extension::qtBaseView::updateUI ( )
inlinevirtualslot

Have the view update its contents.

The public method slot is used to update the view's GUI based on its contents and the state of it's UIManager (category and advance level state, etc..)


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