kspread

KSpread::Validity

KSpread::Validity Class Reference

Validity checks for cell contents. More...

#include <Validity.h>

List of all members.

Public Types

enum  Action { Stop, Warning, Information }
enum  Restriction {
  None, Number, Text, Time,
  Date, Integer, TextLength, List
}

Public Member Functions

 Validity (const Validity &other)
 Validity ()
 ~Validity ()
Action action () const
bool allowEmptyCell () const
Conditional::Type condition () const
bool displayMessage () const
bool displayValidationInformation () const
bool isEmpty () const
void loadOdfValidation (Cell *const cell, const QString &validationName, OdfLoadingContext &tableContext)
bool loadXML (Cell *const cell, const KoXmlElement &validityElement)
const QDate & maximumDate () const
const QTime & maximumTime () const
double maximumValue () const
const QString & message () const
const QString & messageInfo () const
const QDate & minimumDate () const
const QTime & minimumTime () const
double minimumValue () const
bool operator!= (const Validity &other) const
bool operator< (const Validity &) const
void operator= (const Validity &)
bool operator== (const Validity &other) const
Restriction restriction () const
QDomElement saveXML (QDomDocument &doc) const
void setAction (Action action)
void setAllowEmptyCell (bool allow)
void setCondition (Conditional::Type condition)
void setDisplayMessage (bool display)
void setDisplayValidationInformation (bool display)
void setMaximumDate (const QDate &date)
void setMaximumTime (const QTime &time)
void setMaximumValue (double value)
void setMessage (const QString &message)
void setMessageInfo (const QString &info)
void setMinimumDate (const QDate &date)
void setMinimumTime (const QTime &time)
void setMinimumValue (double value)
void setRestriction (Restriction restriction)
void setTitle (const QString &title)
void setTitleInfo (const QString &info)
void setValidityList (const QStringList &list)
bool testValidity (const Cell *cell) const
const QString & title () const
const QString & titleInfo () const
const QStringList & validityList () const

Static Public Member Functions

static QHash< QString,
KoXmlElement > 		preloadValidities (const KoXmlElement &body)

Detailed Description

Validity checks for cell contents.

Author:
Stefan Nikolaus <stefan.nikolaus@kdemail.net>

Definition at line 63 of file Validity.h.

Member Enumeration Documentation

enum KSpread::Validity::Action

The action invoked, if the validity check fails.

Enumerator:
Stop 

Stop.

Warning 

Warn.

Information 

Inform.

Definition at line 67 of file Validity.h.

enum KSpread::Validity::Restriction

The type of the restriction.

Enumerator:
None 

No restriction.

Number 

Restrict to numbers.

Text 

Restrict to texts.

Time 

Restrict to times.

Date 

Restrict to dates.

Integer 

Restrict to integers.

TextLength 

Restrict text length.

List 

Restrict to lists.

Definition at line 74 of file Validity.h.

Constructor & Destructor Documentation

Validity::Validity (  ) 

Constructor.

Creates a validity check, that allows any content.

Definition at line 68 of file Validity.cpp.

Validity::Validity ( const Validity &  other  ) 

Copy Constructor.

Copies the validity other .

Definition at line 81 of file Validity.cpp.

Validity::~Validity (  ) 

Destructor.

Definition at line 86 of file Validity.cpp.

Member Function Documentation

Validity::Action Validity::action (  )  const

Definition at line 546 of file Validity.cpp.

bool Validity::allowEmptyCell (  )  const

Definition at line 551 of file Validity.cpp.

Conditional::Type Validity::condition (  )  const

Definition at line 556 of file Validity.cpp.

bool Validity::displayMessage (  )  const

Definition at line 561 of file Validity.cpp.

bool Validity::displayValidationInformation (  )  const

Definition at line 566 of file Validity.cpp.

bool Validity::isEmpty (  )  const
Returns:
true if this validity check allows any content

Definition at line 90 of file Validity.cpp.

const QDate & Validity::maximumDate (  )  const

Definition at line 576 of file Validity.cpp.

const QTime & Validity::maximumTime (  )  const

Definition at line 581 of file Validity.cpp.

double Validity::maximumValue (  )  const

Definition at line 586 of file Validity.cpp.

const QString & Validity::message (  )  const

Definition at line 591 of file Validity.cpp.

const QString & Validity::messageInfo (  )  const

Definition at line 571 of file Validity.cpp.

const QDate & Validity::minimumDate (  )  const

Definition at line 596 of file Validity.cpp.

const QTime & Validity::minimumTime (  )  const

Definition at line 601 of file Validity.cpp.

double Validity::minimumValue (  )  const

Definition at line 606 of file Validity.cpp.

bool KSpread::Validity::operator!= ( const Validity &  other  )  const [inline]

Definition at line 173 of file Validity.h.

bool KSpread::Validity::operator< ( const Validity &   )  const [inline]
Note:
fake implementation to make QMap happy

Definition at line 170 of file Validity.h.

void Validity::operator= ( const Validity &  other  ) 

Definition at line 926 of file Validity.cpp.

bool Validity::operator== ( const Validity &  other  )  const

Definition at line 931 of file Validity.cpp.

QHash< QString, KoXmlElement > Validity::preloadValidities ( const KoXmlElement &  body  )  [static]

Definition at line 957 of file Validity.cpp.

Validity::Restriction Validity::restriction (  )  const

Definition at line 611 of file Validity.cpp.

void Validity::setAction ( Action  action  ) 

Definition at line 631 of file Validity.cpp.

void Validity::setAllowEmptyCell ( bool  allow  ) 

Definition at line 636 of file Validity.cpp.

void Validity::setCondition ( Conditional::Type  condition  ) 

Definition at line 641 of file Validity.cpp.

void Validity::setDisplayMessage ( bool  display  ) 

Definition at line 646 of file Validity.cpp.

void Validity::setDisplayValidationInformation ( bool  display  ) 

Definition at line 651 of file Validity.cpp.

void Validity::setMaximumDate ( const QDate &  date  ) 

Definition at line 656 of file Validity.cpp.

void Validity::setMaximumTime ( const QTime &  time  ) 

Definition at line 661 of file Validity.cpp.

void Validity::setMaximumValue ( double  value  ) 

Definition at line 666 of file Validity.cpp.

void Validity::setMessage ( const QString &  message  ) 

Definition at line 671 of file Validity.cpp.

void Validity::setMessageInfo ( const QString &  info  ) 

Definition at line 676 of file Validity.cpp.

void Validity::setMinimumDate ( const QDate &  date  ) 

Definition at line 681 of file Validity.cpp.

void Validity::setMinimumTime ( const QTime &  time  ) 

Definition at line 686 of file Validity.cpp.

void Validity::setMinimumValue ( double  value  ) 

Definition at line 691 of file Validity.cpp.

void Validity::setRestriction ( Restriction  restriction  ) 

Definition at line 696 of file Validity.cpp.

void Validity::setTitle ( const QString &  title  ) 

Definition at line 701 of file Validity.cpp.

void Validity::setTitleInfo ( const QString &  info  ) 

Definition at line 706 of file Validity.cpp.

void Validity::setValidityList ( const QStringList &  list  ) 

Definition at line 711 of file Validity.cpp.

bool Validity::testValidity ( const Cell *  cell  )  const

Tests whether the content of cell is allowed.

Returns:
true if the content is valid

Definition at line 716 of file Validity.cpp.

const QString & Validity::title (  )  const

Definition at line 616 of file Validity.cpp.

const QString & Validity::titleInfo (  )  const

Definition at line 621 of file Validity.cpp.

const QStringList & Validity::validityList (  )  const

Definition at line 626 of file Validity.cpp.

The documentation for this class was generated from the following files: