uiLayoutElement.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2007 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: uiLayoutElement.h,v $ $Revision: 1.10 $ $State: Exp $
*********************************************************************/


#ifndef DTUILAYOUTELEMENT_H_
#define DTUILAYOUTELEMENT_H_

#include "entityEditorImpl/uiElement.h"
#include "vrfutil/rwList.h"
#include "vrfutil/rwBoolean.h"

#include <QtCore/QPoint>

class QLayout;

static const char* DtUiLayoutElementType = "DtUiLayoutElement";

#include "entityEditorImpl/entityEditorImplDefines.h"

class DT_DLL_entityeditorimpl DtLayoutElement : public DtUiElement
{
public:
   DtLayoutElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtLayoutElement();

   DtLayoutElement(const DtLayoutElement& orig);

   DtLayoutElement& operator=(const DtLayoutElement& orig);

   virtual void addSpacing();

   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   void setTitle(const DtString& s) { myTitle = s; };
   const DtString& title() const { return myTitle; };

   virtual QWidget* createLabelWidget(QWidget* parent) {return 0;}

   virtual void addWidget(DtUiElement*, QWidget* label, QWidget* control, QWidget* parent) = 0;

   virtual QWidget* joinLabelAndControl(QWidget* label, QWidget* control, QWidget* parent);

protected:
   DtString myTitle;
   QLayout* myLayout;
   QWidget* myBox;
};

class DT_DLL_entityeditorimpl DtGridLayoutElement : public DtLayoutElement
{
public:
   DtGridLayoutElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtGridLayoutElement();

   DtGridLayoutElement(const DtGridLayoutElement& orig);

   DtGridLayoutElement& operator=(const DtGridLayoutElement& orig);

public:
   virtual QWidget* createControls(QWidget*);
   virtual void addWidget(DtUiElement*, QWidget* label, QWidget* control, QWidget* parent);
   virtual void addSpacing();

protected:
   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual DtUiElement* clone();

protected:
   int   myNumColumns;
   QPoint   myGridPosition;
};

class DT_DLL_entityeditorimpl DtHorizontalLayoutElement : public DtLayoutElement
{
public:
   DtHorizontalLayoutElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtHorizontalLayoutElement();

   DtHorizontalLayoutElement(const DtHorizontalLayoutElement& orig);

   DtHorizontalLayoutElement& operator=(const DtHorizontalLayoutElement& orig);

   virtual void addSpacing();

protected:
   virtual QWidget* createControls(QWidget*);
   virtual void addWidget(DtUiElement*, QWidget* label, QWidget* control, QWidget* parent);

protected:
   virtual DtUiElement* clone();
};

class DT_DLL_entityeditorimpl DtVerticalLayoutElement : public DtLayoutElement
{
public:
   DtVerticalLayoutElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtVerticalLayoutElement();

   DtVerticalLayoutElement(const DtVerticalLayoutElement& orig);

   DtVerticalLayoutElement& operator=(const DtVerticalLayoutElement& orig);

   virtual void addSpacing();

protected:
   virtual QWidget* createControls(QWidget*);
   virtual void addWidget(DtUiElement*, QWidget* label, QWidget* control, QWidget* parent);

protected:
   virtual DtUiElement* clone();
};

class DT_DLL_entityeditorimpl DtUiLayoutSignalHandler : public QObject
{
   Q_OBJECT

public:
   DtUiLayoutSignalHandler() {};

signals:
   void uiEvent(const DtUiElementEvent&);

protected slots:
   virtual void sendEvent(const DtUiElementEvent& e) { emit uiEvent(e); };
};

class DT_DLL_entityeditorimpl DtLayoutContainer : public DtRwList
{
public:

   DtLayoutContainer();

   DtLayoutContainer(const DtString& name, DtReaderWriterRegistry*  
      parentRegistry = NULL);

   virtual ~DtLayoutContainer();

   DtLayoutContainer(const DtLayoutContainer& orig, 
      DtReaderWriterRegistry*  parentRegistry = NULL);

   DtLayoutContainer& operator=(const DtLayoutContainer& orig);

   virtual QWidget* createControls(QWidget* parent);

   const DtString& objectName() const { return myObjectName; };
   virtual void setFromParameters(DtReaderWriter* parentRw);
   virtual void addElementChangedCallback(DtElementChangedCallbackFcn f, void* u);
   virtual void removeElementChangedCallback(DtElementChangedCallbackFcn f, void* u);
   virtual bool isModified() const;
   virtual void objectParametersModified();
   virtual void processUiEvent(const DtUiElementEvent&);
   static void subelementChangedCallback(DtUiElement* element, void* usr);

   virtual void removeAllCallbacks();
   virtual void setModelModified(DtModelSetEntry* m);
   virtual void uiState(QMap<QString, QVariant>& state) const;
   virtual void setUiState(const QMap<QString, QVariant>&);

   DtUiLayoutSignalHandler* signalHandler() { return &mySignalHandler; };

protected:
   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);
   virtual void emptyList();
   virtual void copyList(const DtLayoutContainer& orig);

   virtual void processSubelementChanged(DtUiElement* element);

protected:
   DtRwString  myReaderWriterName;
   DtRwString  myTitle;
   DtRwString  myObjectName;
   DtRwBoolean myAddSpacing;
   QWidget*    myBox;
   DtLayoutElement*  myLayout;
   DtCallbackList<DtUiElement*> myElementChangedCallbackList;
   DtUiLayoutSignalHandler mySignalHandler;
};

class DT_DLL_entityeditorimpl DtUiLayoutElement : public DtUiElement
{
public:

   DtUiLayoutElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtUiLayoutElement();

   DtUiLayoutElement(const DtUiLayoutElement& orig);

   DtUiLayoutElement& operator=(const DtUiLayoutElement& orig);

public:
   virtual DtUiElement* clone();
   virtual void merge(DtUiElement*);
   virtual const DtString& objectName() const;

   virtual QWidget* createLabelWidget(QWidget* parent) {return 0;}

   virtual void removeAllCallbacks();
   virtual void uiState(QMap<QString, QVariant>& state) const;
   virtual void setUiState(const QMap<QString, QVariant>&);

protected:
   virtual const char* readerWriterType() const;
   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual QWidget* createControls(QWidget* parent);
   virtual void mergeInto(DtUiForParameter*);
   virtual DtUiElement* elementNamed(const DtString& s);
   virtual bool mergeInto(const DtString& readerWriterName, bool after, DtUiElement* element);
   virtual void setFromParameters(DtReaderWriter* parentRw);
   virtual void addElementChangedCallback(DtElementChangedCallbackFcn f, void* u);
   virtual void removeElementChangedCallback(DtElementChangedCallbackFcn f, void* u);
   virtual bool isModified() const;
   virtual void objectParametersModified() {myLayoutContainer.objectParametersModified();};
   virtual void processUiEvent(const DtUiElementEvent& e) { myLayoutContainer.processUiEvent(e); };
   virtual void setModelModified(DtModelSetEntry* m);

protected:
   DtLayoutContainer myLayoutContainer;
};

class DT_DLL_entityeditorimpl DtUiAddToLayoutElement : public DtUiLayoutElement
{
public:

   DtUiAddToLayoutElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtUiAddToLayoutElement();

   DtUiAddToLayoutElement(const DtUiAddToLayoutElement& orig);

   DtUiAddToLayoutElement& operator=(const DtUiAddToLayoutElement& orig);

protected:
   virtual DtUiElement* clone();
   virtual void mergeInto(DtUiForParameter*);
};

class DT_DLL_entityeditorimpl DtUiAddItemElement : public DtUiLayoutElement
{
public:

   DtUiAddItemElement
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtUiAddItemElement();

   DtUiAddItemElement(const DtUiAddItemElement& orig);

   DtUiAddItemElement& operator=(const DtUiAddItemElement& orig);

protected:
   virtual DtUiElement* clone();
   virtual void mergeInto(DtUiForParameter*);
   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
                                     const DtVariableBindingsList& variableBindings);

protected:
   DtRwString myNear;
   DtRwString myPlacement;
};

#endif