DocumentModelGridDisplay Class Reference

Model for DlgSettingsGridDisplay and CmdSettingsGridDisplay. More...

#include <DocumentModelGridDisplay.h>

Inheritance diagram for DocumentModelGridDisplay:

Collaboration diagram for DocumentModelGridDisplay:

Public Member Functions
	DocumentModelGridDisplay ()
	Default constructor.
	DocumentModelGridDisplay (const Document &document)
	Initial constructor from Document.
	DocumentModelGridDisplay (const DocumentModelGridDisplay &other)
	Copy constructor.
DocumentModelGridDisplay &	operator= (const DocumentModelGridDisplay &other)
	Assignment constructor.
unsigned int	countX () const
	Get method for x grid line count.
unsigned int	countY () const
	Get method for y grid line count.
GridCoordDisable	disableX () const
	Get method for x grid line disabled variable.
GridCoordDisable	disableY () const
	Get method for y grid line disabled variable.
unsigned int	lineWidth () const
	Get method for line width.
virtual void	loadXml (QXmlStreamReader &reader)
	Load model from serialized xml.
ColorPalette	paletteColor () const
	Get method for color.
void	printStream (QString indentation, QTextStream &str) const
	Debugging method that supports print method of this class and printStream method of some other class(es).
virtual void	saveXml (QXmlStreamWriter &writer) const
	Save entire model as xml into stream.
void	setCountX (unsigned int countX)
	Set method for x grid line count.
void	setCountY (unsigned int countY)
	Set method for y grid line count.
void	setDisableX (GridCoordDisable disableX)
	Set method for x grid line disabled variable.
void	setDisableY (GridCoordDisable disableY)
	Set method for y grid line disabled variable.
void	setLineWidth (unsigned int lineWidth)
	Set method for line width.
void	setPaletteColor (ColorPalette paletteColor)
	Set method for color.
void	setStable (bool stable)
	Set method for stable flag.
void	setStartX (double startX)
	Set method for x grid line lower bound (inclusive).
void	setStartY (double yStart)
	Set method for y grid line lower bound (inclusive).
void	setStepX (double stepX)
	Set method for x grid line increment.
void	setStepY (double yStep)
	Set method for y grid line increment.
void	setStopX (double stopX)
	Set method for x grid line upper bound (inclusive).
void	setStopY (double yStop)
	Set method for y grid line upper bound (inclusive).
bool	stable () const
	Get method for stable flag.
double	startX () const
	Get method for x grid line lower bound (inclusive).
double	startY () const
	Get method for y grid line lower bound (inclusive).
double	stepX () const
	Get method for x grid line increment.
double	stepY () const
	Get method for y grid line increment.
double	stopX () const
	Get method for x grid line upper bound (inclusive).
double	stopY () const
	Get method for y grid line upper bound (inclusive).
Public Member Functions inherited from DocumentModelAbstractBase
	DocumentModelAbstractBase ()
	Single constructor.
virtual	~DocumentModelAbstractBase ()
	Single destructor.

Detailed Description

Model for DlgSettingsGridDisplay and CmdSettingsGridDisplay.

External code is responsible for calculating the value of the disabled parameter using the values of the other non-disabled parameters, instead of using the current value of the disabled parameter

Definition at line 21 of file DocumentModelGridDisplay.h.

Constructor & Destructor Documentation

DocumentModelGridDisplay() [1/3]

DocumentModelGridDisplay::DocumentModelGridDisplay

(

)

Default constructor.

Definition at line 21 of file DocumentModelGridDisplay.cpp.

                                                   :
  m_stable (false),
  m_disableX (GRID_COORD_DISABLE_COUNT),
  m_countX (2),
  m_startX (0.0),
  m_stepX (1.0),
  m_stopX (1.0),
  m_disableY (GRID_COORD_DISABLE_COUNT),
  m_countY (2),
  m_startY (0.0),
  m_stepY (1.0),
  m_stopY (1.0),
  m_paletteColor (DEFAULT_COLOR),
  m_lineWidth (DEFAULT_LINE_WIDTH)
{
}

DocumentModelGridDisplay() [2/3]

DocumentModelGridDisplay::DocumentModelGridDisplay

(

const Document &

document

)

Initial constructor from Document.

Definition at line 38 of file DocumentModelGridDisplay.cpp.

                                                                           :
  m_stable (document.modelGridDisplay().stable()),
  m_disableX (document.modelGridDisplay().disableX()),
  m_countX (document.modelGridDisplay().countX()),
  m_startX (document.modelGridDisplay().startX()),
  m_stepX (document.modelGridDisplay().stepX()),
  m_stopX (document.modelGridDisplay().stopX()),
  m_disableY (document.modelGridDisplay().disableY()),
  m_countY (document.modelGridDisplay().countY()),
  m_startY (document.modelGridDisplay().startY()),
  m_stepY (document.modelGridDisplay().stepY()),
  m_stopY (document.modelGridDisplay().stopY()),
  m_paletteColor (document.modelGridDisplay().paletteColor()),
  m_lineWidth (document.modelGridDisplay().lineWidth())
{
}

DocumentModelGridDisplay() [3/3]

DocumentModelGridDisplay::DocumentModelGridDisplay

(

const DocumentModelGridDisplay &

other

)

Copy constructor.

Definition at line 55 of file DocumentModelGridDisplay.cpp.

                                                                                        :
  m_stable(other.stable()),
  m_disableX (other.disableX()),
  m_countX (other.countX()),
  m_startX (other.startX()),
  m_stepX (other.stepX()),
  m_stopX (other.stopX()),
  m_disableY (other.disableY()),
  m_countY (other.countY()),
  m_startY (other.startY()),
  m_stepY (other.stepY()),
  m_stopY (other.stopY()),
  m_paletteColor (other.paletteColor()),
  m_lineWidth (other.lineWidth())
{
}

Member Function Documentation

countX()

unsigned int DocumentModelGridDisplay::countX

(

)

const

Get method for x grid line count.

Definition at line 91 of file DocumentModelGridDisplay.cpp.

{
  return m_countX;
}

countY()

unsigned int DocumentModelGridDisplay::countY

(

)

const

Get method for y grid line count.

Definition at line 96 of file DocumentModelGridDisplay.cpp.

{
  return m_countY;
}

disableX()

GridCoordDisable DocumentModelGridDisplay::disableX

(

)

const

Get method for x grid line disabled variable.

Definition at line 101 of file DocumentModelGridDisplay.cpp.

{
  return m_disableX;
}

disableY()

GridCoordDisable DocumentModelGridDisplay::disableY

(

)

const

Get method for y grid line disabled variable.

Definition at line 106 of file DocumentModelGridDisplay.cpp.

{
  return m_disableY;
}

lineWidth()

unsigned int DocumentModelGridDisplay::lineWidth

(

)

const

Get method for line width.

Definition at line 111 of file DocumentModelGridDisplay.cpp.

{
  return m_lineWidth;
}

loadXml()

void DocumentModelGridDisplay::loadXml ( QXmlStreamReader & reader )

virtual

Load model from serialized xml.

Implements DocumentModelAbstractBase.

Definition at line 116 of file DocumentModelGridDisplay.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelGridDisplay::loadXml";
 
  bool success = true;
 
  QXmlStreamAttributes attributes = reader.attributes();
 
  // Line width is optional
  if (attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STABLE) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_DISABLE_X) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COUNT_X) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_START_X) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STEP_X) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STOP_X) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_DISABLE_Y) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COUNT_Y) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_START_Y) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STEP_Y) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STOP_Y) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COLOR)) {
 
    // Boolean values
    QString stableValue = attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_STABLE).toString();
 
    setStable (stableValue == DOCUMENT_SERIALIZE_BOOL_TRUE);
    setDisableX (static_cast<GridCoordDisable> (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_DISABLE_X).toInt()));
    setCountX (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_COUNT_X).toUInt());
    setStartX (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_START_X).toDouble());
    setStepX (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_STEP_X).toDouble());
    setStopX (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_STOP_X).toDouble());
    setDisableY (static_cast<GridCoordDisable> (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_DISABLE_Y).toUInt()));
    setCountY (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_COUNT_Y).toUInt());
    setStartY (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_START_Y).toDouble());
    setStepY (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_STEP_Y).toDouble());
    setStopY (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_STOP_Y).toDouble());
    setPaletteColor (static_cast<ColorPalette> (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_COLOR).toInt()));
 
    // Optional values
    if (attributes.hasAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_LINE_WIDTH)) {
      setLineWidth (attributes.value(DOCUMENT_SERIALIZE_GRID_DISPLAY_LINE_WIDTH).toUInt());
    } else {
      setLineWidth (DEFAULT_LINE_WIDTH);
    }
 
    // Read until end of this subtree
    while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
    (reader.name() != DOCUMENT_SERIALIZE_GRID_DISPLAY)){
      loadNextFromReader(reader);
      if (reader.atEnd()) {
        success = false;
        break;
      }
    }
  }
 
  if (!success) {
    reader.raiseError (QObject::tr ("Cannot read grid display data"));
  }
}

operator=()

DocumentModelGridDisplay & DocumentModelGridDisplay::operator=

(

const DocumentModelGridDisplay &

other

)

Assignment constructor.

Definition at line 72 of file DocumentModelGridDisplay.cpp.

{
  m_stable = other.stable();
  m_disableX = other.disableX();
  m_countX = other.countX();
  m_startX = other.startX();
  m_stepX = other.stepX();
  m_stopX = other.stopX();
  m_disableY = other.disableY();
  m_countY = other.countY();
  m_startY = other.startY();
  m_stepY = other.stepY();
  m_stopY = other.stopY();
  m_paletteColor = other.paletteColor();
  m_lineWidth = other.lineWidth();
 
  return *this;
}

paletteColor()

ColorPalette DocumentModelGridDisplay::paletteColor

(

)

const

Get method for color.

Definition at line 177 of file DocumentModelGridDisplay.cpp.

{
  return m_paletteColor;
}

printStream()

void DocumentModelGridDisplay::printStream	(	QString	indentation,
		QTextStream &	str ) const

Debugging method that supports print method of this class and printStream method of some other class(es).

Definition at line 182 of file DocumentModelGridDisplay.cpp.

{
  str << indentation << "DocumentModelGridDisplay\n";
 
  indentation += INDENTATION_DELTA;
 
  str << indentation << "stable=" << (m_stable ? "true" : "false") << "\n";
  str << indentation << "disableX=" << m_disableX << "\n";
  str << indentation << "countX=" << m_countX << "\n";
  str << indentation << "startX=" << m_startX << "\n";
  str << indentation << "stepX=" << m_stepX << "\n";
  str << indentation << "stopX=" << m_stopX << "\n";
  str << indentation << "disableY=" << m_disableY << "\n";
  str << indentation << "countY=" << m_countY << "\n";
  str << indentation << "startY=" << m_startY << "\n";
  str << indentation << "stepY=" << m_stepY << "\n";
  str << indentation << "stopY=" << m_stopY << "\n";
  str << indentation << "color=" << colorPaletteToString (m_paletteColor) << "\n";
  str << indentation << "lineWidth=" << m_lineWidth << "\n";
}

saveXml()

void DocumentModelGridDisplay::saveXml ( QXmlStreamWriter & writer ) const

virtual

Save entire model as xml into stream.

Implements DocumentModelAbstractBase.

Definition at line 204 of file DocumentModelGridDisplay.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelGridDisplay::saveXml";
 
  writer.writeStartElement(DOCUMENT_SERIALIZE_GRID_DISPLAY);
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STABLE, m_stable ?
                            DOCUMENT_SERIALIZE_BOOL_TRUE :
                            DOCUMENT_SERIALIZE_BOOL_FALSE);
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_DISABLE_X, QString::number (m_disableX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COUNT_X, QString::number (m_countX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_START_X, QString::number  (m_startX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STEP_X, QString::number (m_stepX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STOP_X, QString::number (m_stopX));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_DISABLE_Y, QString::number (m_disableY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COUNT_Y, QString::number (m_countY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_START_Y, QString::number  (m_startY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STEP_Y, QString::number (m_stepY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_STOP_Y, QString::number (m_stopY));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COLOR, QString::number (m_paletteColor));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_COLOR_STRING, colorPaletteToString (m_paletteColor));
  writer.writeAttribute(DOCUMENT_SERIALIZE_GRID_DISPLAY_LINE_WIDTH, QString::number (m_lineWidth));
  writer.writeEndElement();
}

setCountX()

void DocumentModelGridDisplay::setCountX

(

unsigned int

countX

)

Set method for x grid line count.

Definition at line 228 of file DocumentModelGridDisplay.cpp.

{
  m_countX = countX;
}

setCountY()

void DocumentModelGridDisplay::setCountY

(

unsigned int

countY

)

Set method for y grid line count.

Definition at line 233 of file DocumentModelGridDisplay.cpp.

{
  m_countY = countY;
}

setDisableX()

void DocumentModelGridDisplay::setDisableX

(

GridCoordDisable

disableX

)

Set method for x grid line disabled variable.

Definition at line 238 of file DocumentModelGridDisplay.cpp.

{
  m_disableX = disableX;
}

setDisableY()

void DocumentModelGridDisplay::setDisableY

(

GridCoordDisable

disableY

)

Set method for y grid line disabled variable.

Definition at line 243 of file DocumentModelGridDisplay.cpp.

{
  m_disableY = disableY;
}

setLineWidth()

void DocumentModelGridDisplay::setLineWidth

(

unsigned int

lineWidth

)

Set method for line width.

Definition at line 248 of file DocumentModelGridDisplay.cpp.

{
  m_lineWidth = lineWidth;
}

setPaletteColor()

void DocumentModelGridDisplay::setPaletteColor

(

ColorPalette

paletteColor

)

Set method for color.

Definition at line 253 of file DocumentModelGridDisplay.cpp.

{
  m_paletteColor = paletteColor;
}

setStable()

void DocumentModelGridDisplay::setStable

(

bool

stable

)

Set method for stable flag.

Definition at line 258 of file DocumentModelGridDisplay.cpp.

{
  m_stable = stable;
}

setStartX()

void DocumentModelGridDisplay::setStartX

(

double

startX

)

Set method for x grid line lower bound (inclusive).

Definition at line 263 of file DocumentModelGridDisplay.cpp.

{
  m_startX = startX;
}

setStartY()

void DocumentModelGridDisplay::setStartY

(

double

yStart

)

Set method for y grid line lower bound (inclusive).

Definition at line 268 of file DocumentModelGridDisplay.cpp.

{
  m_startY = startY;
}

setStepX()

void DocumentModelGridDisplay::setStepX

(

double

stepX

)

Set method for x grid line increment.

Definition at line 273 of file DocumentModelGridDisplay.cpp.

{
  m_stepX = stepX;
}

setStepY()

void DocumentModelGridDisplay::setStepY

(

double

yStep

)

Set method for y grid line increment.

Definition at line 278 of file DocumentModelGridDisplay.cpp.

{
  m_stepY = stepY;
}

setStopX()

void DocumentModelGridDisplay::setStopX

(

double

stopX

)

Set method for x grid line upper bound (inclusive).

Definition at line 283 of file DocumentModelGridDisplay.cpp.

{
  m_stopX = stopX;
}

setStopY()

void DocumentModelGridDisplay::setStopY

(

double

yStop

)

Set method for y grid line upper bound (inclusive).

Definition at line 288 of file DocumentModelGridDisplay.cpp.

{
  m_stopY = stopY;
}

stable()

bool DocumentModelGridDisplay::stable

(

)

const

Get method for stable flag.

The flag is false to let the settings get automatically updated, until the user selects settings - at which point the stable flag is set to true

Definition at line 293 of file DocumentModelGridDisplay.cpp.

{
  return m_stable;
}

startX()

double DocumentModelGridDisplay::startX

(

)

const

Get method for x grid line lower bound (inclusive).

Definition at line 298 of file DocumentModelGridDisplay.cpp.

{
  return m_startX;
}

startY()

double DocumentModelGridDisplay::startY

(

)

const

Get method for y grid line lower bound (inclusive).

Definition at line 303 of file DocumentModelGridDisplay.cpp.

{
  return m_startY;
}

stepX()

double DocumentModelGridDisplay::stepX

(

)

const

Get method for x grid line increment.

Definition at line 308 of file DocumentModelGridDisplay.cpp.

{
  return m_stepX;
}

stepY()

double DocumentModelGridDisplay::stepY

(

)

const

Get method for y grid line increment.

Definition at line 313 of file DocumentModelGridDisplay.cpp.

{
  return m_stepY;
}

stopX()

double DocumentModelGridDisplay::stopX

(

)

const

Get method for x grid line upper bound (inclusive).

Definition at line 318 of file DocumentModelGridDisplay.cpp.

{
  return m_stopX;
}

stopY()

double DocumentModelGridDisplay::stopY

(

)

const

Get method for y grid line upper bound (inclusive).

Definition at line 323 of file DocumentModelGridDisplay.cpp.

{
  return m_stopY;
}

---

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

• Document/DocumentModelGridDisplay.h
• Document/DocumentModelGridDisplay.cpp