WsModule.h

Go to the documentation of this file.

/*
* Copyright (C) 2006-Today Guy Deleeuw
*
* See the LICENSE file for terms of use.
*/

#ifndef WS_MODULE_H__
#define WS_MODULE_H__    1

#include <string>

#include <boost/any.hpp>

#include <Wt/WContainerWidget>
#include <Wt/WWidget>
#include <Main/WsOption.h>

class WsContentButtonsBar;


class WsEditorWidget : public Wt::WContainerWidget {
public :
  WsEditorWidget(Wt::WContainerWidget* parent = 0);
  ~WsEditorWidget();
  virtual void          load();
  virtual bool          saveEditor();
};



class WsModule : public Wt::WObject, public WsOptions {
public:
  WsModule();
  virtual Wt::WWidget*               createContentsMenuBar(Wt::WContainerWidget* parent = 0) const = 0;
  virtual Wt::WWidget*               createContents(Wt::WContainerWidget* parent = 0) const = 0;
  virtual WsEditorWidget*            createEditor(Wt::WContainerWidget* parent = 0) const = 0;
  virtual Wt::WWidget*               createAdmin(Wt::WContainerWidget* parent = 0) const = 0;
  virtual std::string                description() const = 0;
  virtual std::string                checkPath(const std::string& currentPath);

  void                               setModuleName(const std::string& name);
  const std::string&                 moduleName() const;

  void                               setSoName(const std::string& soName);
  const std::string&                 soName() const;

  // TODO : add multiple values for the fileName ?
  void                               setFileName(const std::string& fileName);
  const std::string&                 fileName() const;

  void                               setExtensions(const std::string& extensions);
  const std::string&                 extension(const std::string& extension = "") const;

  void                               setPrefix(const std::string& prefix);
  const std::string&                 prefix() const;
  std::string                        pathWithoutPrefix(const std::string& path);
  std::string                        pathWithPrefix(const std::string& path);
  virtual bool                       processPrefix(const std::string& path);

  // TODO : put this in the config management system
  void                               setHideImages(const bool bHide);
  bool                               hideImages();

  void                               setSysPath(const std::string& sysPath);
  const std::string&                 sysPath() const ;

  void                               setDiffPath(const std::string& diffPath);
  const std::string&                 diffPath() const ;

  WsContentButtonsBar*               contentButtonsBar();
  virtual void                       destroyContentsMenuBar();

  void                               setLoaded();
  bool                               isLoaded();

private :
  std::string                        m_moduleName;
  std::string                        m_soName;
  std::string                        m_fileName;
  std::string                        m_extension;
  std::string                        m_prefix;
  std::vector<std::string>           m_extensions;
  std::string                        m_sysPath;
  std::string                        m_diffPath;
  bool                               m_bLoaded;
  bool                               m_bHideImages;
};

typedef WsModule* (*pf_wsModule)           ();

#endif // ifndef WsModule_H__