koffice/kugar/lib/mfieldobject.h

/***************************************************************************
             mfieldobject.h  -  Kugar report field object
             -------------------
   begin     : Mon Aug 23 1999
   copyright : (C) 1999 by Mutiny Bay Software
   email     : info@mutinybaysoftware.com
***************************************************************************/

#ifndef MFIELDOBJECT_H
#define MFIELDOBJECT_H

#include <tqregexp.h>

#include "mlabelobject.h"

/**Kugar report field object
  *@author Mutiny Bay Software
  */

namespace Kugar
{

class InputMask;

class MFieldObject : public MLabelObject
{

public:
    /** Data type constants */
    enum DataType { String = 0, Integer, Float, Date, Currency};

    /** Constructor */
    MFieldObject();
    /** Copy constructor */
    MFieldObject( const MFieldObject& mFieldObject );
    /** Assignment operator */
    MFieldObject operator=( const MFieldObject& mFieldObject );
    /** Destructor */
    virtual ~MFieldObject();

protected:
    /** Field name */
    TQString fieldName;
    /** Field data type */
    int dataType;
    /** Field date format */
    int format;
    /** Field precision */
    int precision;
    /** Field currency symbol */
    TQChar currency;
    /** Field's negative value color */
    TQColor negativeValueColor;
    /** Field's original color */
    TQColor saveColor;
    /** Field's comma flag */
    int comma;
    /** Input mask */
    TQString inputMask;

public:
    /** Returns the bound data field name */
    TQString getFieldName();
    /** Sets the bound data field */
    void setFieldName( const TQString field );
    /** Sets the field's data string - default is an empty string*/
    void setText( const TQString txt );
    /** Sets the field's data type */
    void setDataType( int t );
    /** Sets the field's date formatting */
    void setDateFormat( int f );
    /** Sets the field's precision */
    void setPrecision( int p );
    /** Sets the field's currency symbol */
    void setCurrency( const TQChar c );
    /** Sets the object's negative value color - default is red*/
    void setNegValueColor( int r, int g, int b );
    /** Sets if object should delimit numeric values with commas */
    void setCommaSeparator( int c );

    TQString getInputMask() const;
    void setInputMask( const TQString &inputMask );

private:
    /** Formats a string representation of a negative number using the negative value color */
    void formatNegValue();
    /** Formats a string representation of number with comma seperators */
    void formatCommas();
    void parseInputMask();

    /** Copies member data from one object to another.
      * Used by the copy constructor and assignment operator
      */
    void copy( const MFieldObject* mFieldObject );

    InputMask *m_inputMask;

};

}

#endif