FieldDefBase.h

/**************************************************************************
###########################################################################
##
## $SHOWOFFDB_BEGIN_LICENSE$
## Copyright (C) 2011 Lorimark Solutions, LLC and/or its subsidiary(-ies).
##  All rights reserved.
##  Contact: Lorimark Solutions, LLC (info@showoff-db.org)
##
## This file is part of the Showoff Database Application Framework.
##
##  Commercial Usage
##  Licensees holding valid ShowoffDB Commercial licenses may use this file in
##   accordance with the ShowoffDB Commercial License Agreement provided with the
##   Software or, alternatively, in accordance with the terms contained in
##   a written agreement between you and Lorimark Solutions, LLC.
##
## GNU Lesser General Public License Usage
##  Alternatively, this file may be used under the terms of the GNU Lesser
##   General Public License version 2.1 as published by the Free Software
##   Foundation and appearing in the file LICENSE.LGPL included in the
##   packaging of this file.  Please review the following information to
##   ensure the GNU Lesser General Public License version 2.1 requirements
##   will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
##
## In addition, as a special exception, Lorimark Solutions, LLC gives
##  you certain additional rights.  These rights are described in the
##  Lorimark Solutions, LLC ShowoffDB LGPL Exception version 1.0, included in
##  the file LGPL_EXCEPTION.txt in this package.
##
## GNU General Public License Usage
##  Alternatively, this file may be used under the terms of the GNU
##   General Public License version 3.0 as published by the Free Software
##   Foundation and appearing in the file LICENSE.GPL included in the
##   packaging of this file.  Please review the following information to
##   ensure the GNU General Public License version 3.0 requirements will be
##   met: http://www.gnu.org/copyleft/gpl.html.
##
## If you have questions regarding the use of this file, please contact
##   Lorimark Solutions, LLC at info@showoff-db.org.
## $SHOWOFFDB_END_LICENSE$
##
#############################################################################
****************************************************************************/


#ifndef __WTX_DBO_FIELDDEFBASE_H_234e0174_6b7d_11e8_b503_fb1ef3651ec0__
#define __WTX_DBO_FIELDDEFBASE_H_234e0174_6b7d_11e8_b503_fb1ef3651ec0__

#include <memory>
#include <string>

#include <Wt/WObject.h>
#include <Wt/WFlags.h>
#include <Wt/WLineEdit.h>
#include "Session.h"

namespace Wt {
  class WWidget;
  class WItemDelegate;
}

namespace Wtx {
  namespace Dbo {

class TableDef;

class FieldDefBase
: Wt::WObject
{
  public:

    enum Flags
    {
      None     = 0x0000,

      Required = 0x0001,

      ReadOnly = 0x0002,

      Password = 0x0004,

      ShowOnly = 0x0008,

      NoUi     = 0x0010,

      Unique   = 0x0020,

      Search   = 0x0040
    };

    FieldDefBase
    (
      TableDef &   td,                
      const char * fn,                
      int          w   = -1,          
      int          h   = -1,          
      Flags        f   = Flags::None, 
      std::string  lb  = "",          
      std::string  ph  = "",          
      std::string  inf = "",          
      std::string  tt  = "",          
      int          ht  = -1           
    );

    FieldDefBase
    (
      TableDef &   td,                
      const char * fn,                
      std::string  lb  = "",          
      std::string  ph  = "",          
      std::string  inf = "",          
      std::string  tt  = "",          
      int          ht  = -1           
    );

#ifdef NEVER

    FieldDef
    (
      TableDef &   td,                
      const char * fn,                
      Flags        f   = Flags::None 
//      int          w   = -1,          /// width
//      int          h   = -1,          /// height
//      std::string  lb  = "",          /// label
//      std::string  ph  = "",          /// placeholder text
//      std::string  inf = "",          /// info
//      std::string  tt  = "",          /// tooltipText
//      int          ht  = -1           /// help topic
    );
#endif

    virtual ~FieldDefBase() {}

    virtual Wtx::Dbo::TableDef & tableDef() const;

    virtual const char * fieldName() const;

    /*
    ** this alias name is useful for when implementing new database
    **  systems, when importing data from some other system, it is
    **  sometimes useful to encode the foreign column name here so
    **  that import/export can be more seamless.
    **
    */
    virtual const std::string & aliasName() const;

    virtual int width() const;
    virtual void setWidth( int value );

    virtual int height() const;
    virtual void setHeight( int value );

    virtual bool isVisible() const;
    virtual void setIsVisible( bool value=true );

    virtual bool isReadOnly() const;
    virtual void setIsReadOnly( bool value=true );

    virtual bool isUnique() const;
    virtual void setIsUnique( bool value=true );

    virtual const std::string & label() const;
    virtual void setLabel( const std::string & value );

    virtual const std::string & placeholderText() const;
    virtual void setPlaceholderText( const std::string & value );

    virtual const std::string & info() const;
    virtual void setInfo( const std::string & value );

    virtual const std::string & toolTip() const;
    virtual void setToolTip( const std::string & value );

    virtual int helpTopic() const;
    virtual void setHelpTopic( int value );

    virtual const Flags & flags() const;
    virtual void setFlags( const Flags value );

    virtual const std::string & defaultValue() const;
    virtual void setDefaultValue( const std::string & value );

    virtual bool forceUppercase() const;
    virtual void setForceUppercase( bool value = true );

    virtual const std::string & inputMask() const;
    virtual void setInputMask( const std::string & mask = "", Wt::WFlags< Wt::InputMaskFlag > flags = Wt::None  );

    virtual std::unique_ptr<Wt::WItemDelegate> createItemDelegate( int sid, Wtx::Dbo::Session & session ) const;
    virtual std::unique_ptr<Wt::WWidget> createLabelWidget( int sid, Wtx::Dbo::Session & session ) const;
    virtual std::unique_ptr<Wt::WWidget> createEditWidget( int sid, Wtx::Dbo::Session & session ) const;
    virtual std::unique_ptr<Wt::WWidget> createDisplayWidget( int sid, Wtx::Dbo::Session & session ) const;

    virtual std::string toJson() const;
    virtual void fromJson( const std::string & valud );

  private:

    void init();

    TableDef & m_tableDef;
    const char * m_fieldName;
    std::string m_aliasName;

    int m_width = -1;
    int m_height = -1;
    bool m_isReadOnly = false;
    bool m_isVisible = true;
    bool m_isUnique = false;
    bool m_forceUppercase = false;
    Flags m_flags = None;
    std::string m_label;
    std::string m_placeholderText;
    std::string m_info;
    std::string m_toolTip;
    std::string m_defaultValue;
    std::string m_inputMask;
    Wt::WFlags< Wt::InputMaskFlag > m_inputMaskFlags;
    int m_helpTopic = 0;


}; // endclass Wtx::Dbo::FieldDef

  } // endnamespace Dbo
} // endnamespace Wtx

#endif // #ifndef __WTX_DBO_FIELDDEF_H___