qCTKPimpl.h File Reference

#include <QtGlobal>

Classes
class	qCTKPrivate< PUB >
class	qCTKPrivateInterface< PUB, PVT >
Defines
#define	QCTK_CONSTRUCTOR_1_ARG_CXX(PUB, _ARG1)
#define	QCTK_CONSTRUCTOR_NO_ARG_CXX(PUB)
#define	QCTK_D(PUB) PUB##Private* d = qctk_d()
#define	QCTK_D_REF(PUB) PUB##Private& d = qctk_d.ref()
#define	QCTK_DECLARE_PRIVATE(PUB)
#define	QCTK_DECLARE_PUBLIC(PUB) friend class PUB;
#define	QCTK_GET_CXX(PUB, _TYPE, _NAME, _VARNAME)
#define	QCTK_INIT_PRIVATE(PUB) qctk_d.setPublic(this)
#define	QCTK_P(PUB) PUB* p = qctk_p()
#define	QCTK_P_REF(PUB) PUB& p = qctk_p_ref()
#define	QCTK_SET_CXX(PUB, _TYPE, _NAME, _VARNAME)

Define Documentation

#define QCTK_CONSTRUCTOR_1_ARG_CXX	(	PUB,
		_ARG1		)	`[related]`

Value:

PUB::PUB(_ARG1 _parent) :                     \
    Superclass( _parent )                       \
    {                                           \
    QCTK_INIT_PRIVATE(PUB);                     \
    }

Define a public class constructor with one argument

Also make sure the Pimpl is initalized

#define QCTK_CONSTRUCTOR_NO_ARG_CXX ( PUB ) [related]

Value:

PUB::PUB()                             \
    {                                    \
    QCTK_INIT_PRIVATE(PUB);              \
    }

Define a public class constructor with no argument

Also make sure the Pimpl is initalized

#define QCTK_D ( PUB ) PUB##Private* d = qctk_d() [related]

Returns a pointer (or reference) in the current scope named "d" to the private class.

This function is only available in a class using QCTK_DECLARE_PRIVATE.

#define QCTK_D_REF ( PUB ) PUB##Private& d = qctk_d.ref()

#define QCTK_DECLARE_PRIVATE ( PUB ) [related]

Value:

friend class PUB##Private; qCTKPrivateInterface<PUB, PUB##Private> qctk_d; \
typedef PUB Self;

Declares that a public class has a related private class.

This should be put in the private section of the public class. The parameter is the name of the public class. For convenience, this macro also add 'typedef PUB Self;'

#define QCTK_DECLARE_PUBLIC ( PUB ) friend class PUB; [related]

Declares that a private class has a related public class.

This may be put anywhere in the declaration of the private class. The parameter is the name of the public class.

#define QCTK_GET_CXX	(	PUB,
		_TYPE,
		_NAME,
		_VARNAME	)	`[related]`

Value:

_TYPE PUB::_NAME()const                          \
  {                                                \
    return qctk_d.ref()._VARNAME;                  \
  }

Define the setter in the public class.

This should be put in the .cxx file of the public class. The parameter are the name of the public class (PUB), the type of the argument to return (_TYPE), the name of the setter(_NAME) and the name of the variable in the Private class(_VARNAME).

#define QCTK_INIT_PRIVATE ( PUB ) qctk_d.setPublic(this) [related]

Initializes resources owned by the private class.

This should be called from the public class's constructor, before qctk_d() is used for the first time. The parameter is the name of the public class.

Referenced by qCTKAddRemoveComboBox::qCTKAddRemoveComboBox(), qCTKButtonGroup::qCTKButtonGroup(), qCTKCollapsibleButton::qCTKCollapsibleButton(), qCTKCollapsibleWidget2::qCTKCollapsibleWidget2(), qCTKDoubleRangeSlider::qCTKDoubleRangeSlider(), qCTKDoubleSlider::qCTKDoubleSlider(), qCTKDynamicSpacer::qCTKDynamicSpacer(), qCTKMatrixWidget::qCTKMatrixWidget(), qCTKMenuButton::qCTKMenuButton(), qCTKModelTester::qCTKModelTester(), qCTKNumericInput::qCTKNumericInput(), qCTKRangeSlider::qCTKRangeSlider(), qCTKRangeWidget::qCTKRangeWidget(), qCTKSlider::qCTKSlider(), qCTKSliderSpinBoxWidget::qCTKSliderSpinBoxWidget(), qCTKTreeComboBox::qCTKTreeComboBox(), qMRMLAbstractItemHelper::qMRMLAbstractItemHelper(), qMRMLAbstractNodeItemHelper::qMRMLAbstractNodeItemHelper(), qMRMLAbstractRootItemHelper::qMRMLAbstractRootItemHelper(), qMRMLAbstractSceneItemHelper::qMRMLAbstractSceneItemHelper(), qMRMLEventLogger::qMRMLEventLogger(), qMRMLEventLoggerWidget::qMRMLEventLoggerWidget(), qMRMLExtraItemsHelper::qMRMLExtraItemsHelper(), qMRMLItemModel::qMRMLItemModel(), qMRMLLinearTransformSlider::qMRMLLinearTransformSlider(), qMRMLListWidget::qMRMLListWidget(), qMRMLNodeComboBox::qMRMLNodeComboBox(), qMRMLNodeFactoryButton::qMRMLNodeFactoryButton(), qMRMLNodeItemHelper::qMRMLNodeItemHelper(), qMRMLNodeSelector::qMRMLNodeSelector(), qMRMLNodeTreeSelector::qMRMLNodeTreeSelector(), qMRMLProxyItemHelper::qMRMLProxyItemHelper(), qMRMLSceneFactoryWidget::qMRMLSceneFactoryWidget(), qMRMLSceneModel::qMRMLSceneModel(), qMRMLSceneModelItemHelperFactory::qMRMLSceneModelItemHelperFactory(), qMRMLSortFilterProxyModel::qMRMLSortFilterProxyModel(), qMRMLTransformProxyModel::qMRMLTransformProxyModel(), qMRMLTransformSliders::qMRMLTransformSliders(), qMRMLTreeProxyModel::qMRMLTreeProxyModel(), qMRMLTreeWidget::qMRMLTreeWidget(), qMRMLVariantArrayItemHelper::qMRMLVariantArrayItemHelper(), qMRMLVolumeThresholdWidget::qMRMLVolumeThresholdWidget(), qMRMLWindowLevelWidget::qMRMLWindowLevelWidget(), qSlicerApplication::qSlicerApplication(), qSlicerCLIExecutableModuleFactory::qSlicerCLIExecutableModuleFactory(), qSlicerCLILoadableModule::qSlicerCLILoadableModule(), qSlicerCLILoadableModuleFactory::qSlicerCLILoadableModuleFactory(), qSlicerCLIModule::qSlicerCLIModule(), qSlicerCLIModuleWidget::qSlicerCLIModuleWidget(), qSlicerCommandOptions::qSlicerCommandOptions(), qSlicerCoreApplication::qSlicerCoreApplication(), qSlicerCoreCommandOptions::qSlicerCoreCommandOptions(), qSlicerCoreIOManager::qSlicerCoreIOManager(), qSlicerCoreModuleFactory::qSlicerCoreModuleFactory(), qSlicerIOManager::qSlicerIOManager(), qSlicerLoadableModuleFactory::qSlicerLoadableModuleFactory(), qSlicerMainWindow::qSlicerMainWindow(), qSlicerMainWindowCore::qSlicerMainWindowCore(), qSlicerMeasurementsAngleWidget::qSlicerMeasurementsAngleWidget(), qSlicerMeasurementsRulerWidget::qSlicerMeasurementsRulerWidget(), qSlicermiAnnotationModuleWidget::qSlicermiAnnotationModuleWidget(), qSlicerModuleFactoryManager::qSlicerModuleFactoryManager(), qSlicerModuleManager::qSlicerModuleManager(), qSlicerModulePanel::qSlicerModulePanel(), qSlicerModuleSelectorWidget::qSlicerModuleSelectorWidget(), qSlicerScalarVolumeDisplayWidget::qSlicerScalarVolumeDisplayWidget(), qSlicerWidget::qSlicerWidget(), qVTKAbstractMatrixWidget::qVTKAbstractMatrixWidget(), qVTKCommandOptions::qVTKCommandOptions(), qVTKConnection::qVTKConnection(), qVTKObjectEventsObserver::qVTKObjectEventsObserver(), qVTKObjectTest::qVTKObjectTest(), qVTKRenderView::qVTKRenderView(), and vtkSlicermiAnnotationModuleLogic::vtkSlicermiAnnotationModuleLogic().

#define QCTK_P ( PUB ) PUB* p = qctk_p() [related]

Creates a pointer ( or reference) in the current scope named "q" to the public class.

This macro only works in a class using QCTK_DECLARE_PUBLIC.

#define QCTK_P_REF ( PUB ) PUB& p = qctk_p_ref()

#define QCTK_SET_CXX	(	PUB,
		_TYPE,
		_NAME,
		_VARNAME	)	`[related]`

Value:

void PUB::_NAME(_TYPE var)                        \
  {                                                 \
    qctk_d.ref()._VARNAME =  var;                   \
  }

Define the setter in the public class.

This should be put in the .cxx file of the public class. The parameter are the name of the public class (PUB), the type of the argument to return (_TYPE), the name of the getter(_NAME) and the name of the variable in the Private class(_VARNAME).

qCTKPimpl.h File Reference

Classes

Defines

Define Documentation