parameterDocumentationWidget.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include <vrvUtil/signalslib.h>


#include "ui_parameterDocumentationAreaUi.h"

namespace makVrv
{
   class DtDe;
}

class DtReaderWriterClassMemberDataRecord;

class DtParameterDocumentationWidget: public QWidget
{
   Q_OBJECT

public:

   DtParameterDocumentationWidget(makVrv::DtDe&, QWidget* parent = NULL, 
      const Qt::WindowFlags& flags = 0);

   virtual ~DtParameterDocumentationWidget();

   // Set the the parameter documentation in this widget.  Returns true
   // if there is valid data (i.e. parameterDocumentation.myName is not empty),
   // false, otherwise.
   virtual bool setParameterDocumentation(
      const DtReaderWriterClassMemberDataRecord& parameterDocumentation);
   
   // Set the the parameter parameter name to "Not Avaialable" and all other
   // fields blank.
   virtual void clearParameterDocumentation();

protected:
   makVrv::DtDe& myDe;
   Ui::parameterDocumentationAreaUi myUiImpl;
};