koffice/filters/kspread/excel/sidewinder/format.cpp

/* Swinder - Portable library for spreadsheet
   Copyright (C) 2003-2006 Ariya Hidayat <ariya@kde.org>
   Copyright (C) 2006 Marijn Kruisselbrink <m.kruisselbrink@student.tue.nl>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
   
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA
*/

#include "format.h"

#include "ustring.h"


using namespace Swinder;

class FormatFont::Private
{
public:
  bool null : 1 ;
  bool bold  : 1;
  bool italic : 1;
  bool underline : 1;
  bool strikeout : 1;
  bool subscript : 1;
  bool superscript : 1;
  UString fontFamily;
  double fontSize;
  Color color;

  static UString defaultFont;
};

UString FormatFont::Private::defaultFont("Arial");

FormatFont::FormatFont()
{
  d = new FormatFont::Private();
  d->null        = true;
  d->fontFamily  = Private::defaultFont;
  d->fontSize    = 11;
  d->bold        = false;
  d->italic      = false;
  d->underline   = false;
  d->strikeout   = false;
  d->subscript   = false;
  d->superscript = false;
}

FormatFont::~FormatFont()
{
  delete d;
}

FormatFont::FormatFont( const FormatFont& f )
{
  d = new FormatFont::Private();
  assign( f );
}

FormatFont& FormatFont::operator=( const FormatFont& f )
{
  return assign( f );
}

FormatFont& FormatFont::assign( const FormatFont& f )
{
  d->null        = f.isNull();
  d->fontFamily  = f.fontFamily();
  d->fontSize    = f.fontSize();
  d->color       = f.color();
  d->bold        = f.bold();
  d->italic      = f.italic();
  d->underline   = f.underline();
  d->strikeout   = f.strikeout();
  d->subscript   = f.subscript();
  d->superscript = f.superscript();
  
  return *this;
}

bool FormatFont::isNull() const
{
  return d->null;
}

const UString& FormatFont::fontFamily() const
{
  return d->fontFamily;
}

void FormatFont::setFontFamily( const UString& fontFamily )
{
  d->fontFamily = fontFamily;
  d->null = false;
}

double FormatFont::fontSize() const
{
  return d->fontSize;
}
  
void FormatFont::setFontSize( double fs )
{
  d->fontSize = fs;
  d->null = false;
}

Color FormatFont::color() const
{
  return d->color;
}

void FormatFont::setColor( const Color& c )
{
  d->color = c;
  d->null = false;
}

bool FormatFont::bold() const
{
  return d->bold;
}

void FormatFont::setBold( bool b )
{
  d->bold = b;
  d->null = false;
}

bool FormatFont::italic() const
{
  return d->italic;
}

void FormatFont::setItalic( bool b )
{
  d->italic = b;
  d->null = false;
}

bool FormatFont::underline() const
{
  return d->underline;
}

void FormatFont::setUnderline( bool b )
{
  d->underline = b;
  d->null = false;
}

bool FormatFont::strikeout() const
{
  return d->strikeout;
}

void FormatFont::setStrikeout( bool s )
{
  d->strikeout = s;
  d->null = false;
}

bool FormatFont::subscript() const
{
  return d->subscript;
}

void FormatFont::setSubscript( bool s )
{
  d->subscript = s;
  d->null = false;

  // mutually exclusive
  if( d->subscript && d->superscript )
    d->superscript = false;
}

bool FormatFont::superscript() const
{
  return d->superscript;
}

void FormatFont::setSuperscript( bool s )
{
  d->superscript = s;
  d->null = false;

  // mutually exclusive
  if( d->superscript && d->subscript )
    d->subscript = false;
}

bool FormatFont::operator==(const FormatFont& font) const
{
	return 
    d->bold == font.d->bold &&
    d->italic == font.d->italic &&
    d->underline == font.d->underline &&
    d->strikeout == font.d->strikeout &&
    d->subscript == font.d->subscript &&
    d->superscript == font.d->superscript &&
    d->fontFamily == font.d->fontFamily &&
    d->fontSize == font.d->fontSize &&
    d->color == font.d->color;
}

bool FormatFont::operator!=(const FormatFont& font) const
{
	return 
    d->bold != font.d->bold ||
    d->italic != font.d->italic ||
    d->underline != font.d->underline ||
    d->strikeout != font.d->strikeout ||
    d->subscript != font.d->subscript ||
    d->superscript != font.d->superscript ||
    d->fontFamily != font.d->fontFamily ||
    d->fontSize != font.d->fontSize ||
    d->color != font.d->color;
}

class FormatAlignment::Private
{
public:
  bool null;
  unsigned alignX;
  unsigned alignY;
  bool wrap;
  unsigned indentLevel;
  unsigned rotationAngle;
};

FormatAlignment::FormatAlignment()
{
  d = new FormatAlignment::Private;
  d->null          = true;
  d->alignX        = Format::Left;
  d->alignY        = Format::Middle;
  d->wrap          = false;
  d->indentLevel   = 0;
  d->rotationAngle = 0;
}

// destructor
FormatAlignment::~FormatAlignment()
{
  delete d;
}

// copy constructor
FormatAlignment::FormatAlignment( const FormatAlignment& align )
{
  d = new FormatAlignment::Private;
  assign( align );
}

// assignment operator
FormatAlignment& FormatAlignment::operator=( const FormatAlignment& align )
{
  return assign( align );
}

// assign from another alignment
FormatAlignment& FormatAlignment::assign( const FormatAlignment& align )
{
  d->null          = align.isNull();
  d->alignX        = align.alignX();
  d->alignY        = align.alignY();
  d->wrap          = align.wrap();
  d->indentLevel   = align.indentLevel();
  d->rotationAngle = align.rotationAngle();
  return *this;
}

bool FormatAlignment::isNull() const
{
  return d->null;
}

unsigned FormatAlignment::alignX() const
{
  return d->alignX;
}

void FormatAlignment::setAlignX( unsigned xa )
{
  d->alignX = xa;
  d->null = false;
}

unsigned FormatAlignment::alignY() const
{
  return d->alignY;
}

void FormatAlignment::setAlignY( unsigned ya )
{
  d->alignY = ya;
  d->null = false;
}

bool FormatAlignment::wrap() const
{
  return d->wrap;
}

void FormatAlignment::setWrap( bool w )
{
  d->wrap = w;
  d->null = false;
}

unsigned FormatAlignment::indentLevel() const
{
  return d->indentLevel;
}

void FormatAlignment::setIndentLevel( unsigned i )
{
  d->indentLevel = i;
  d->null = false;
}

unsigned FormatAlignment::rotationAngle() const
{
  return d->rotationAngle;
}

void FormatAlignment::setRotationAngle( unsigned r )
{
  d->rotationAngle = r;
  d->null = false;
}

bool FormatAlignment::operator==(const FormatAlignment& font) const
{
	return 
    d->alignX == font.d->alignX &&
    d->alignY == font.d->alignY &&
    d->wrap == font.d->wrap &&
    d->indentLevel == font.d->indentLevel &&
    d->rotationAngle == font.d->rotationAngle;
}

bool FormatAlignment::operator!=(const FormatAlignment& font) const
{
	return 
    d->alignX != font.d->alignX ||
    d->alignY != font.d->alignY ||
    d->wrap != font.d->wrap ||
    d->indentLevel != font.d->indentLevel ||
    d->rotationAngle != font.d->rotationAngle;
}

class FormatBackground::Private
{
public:
  bool null;
  unsigned pattern;
  Color background;
  Color foreground;
};

// constructor
FormatBackground::FormatBackground()
{
  d = new FormatBackground::Private();
  d->null = true;
}

// destructor
FormatBackground::~FormatBackground()
{
  delete d;
}

// copy constructor
FormatBackground::FormatBackground( const FormatBackground& background )
{
  d = new FormatBackground::Private;
  assign( background );
}

// assignment operator
FormatBackground& FormatBackground::operator=( const FormatBackground& background )
{
  return assign( background );
}

// assign from another alignment
FormatBackground& FormatBackground::assign( const FormatBackground& background )
{
  d->null         = background.isNull();
  d->pattern      = background.pattern();
  d->background   = background.backgroundColor();
  d->foreground   = background.foregroundColor();
  return *this;
}

bool FormatBackground::isNull() const
{
  return d->null;
}

unsigned FormatBackground::pattern() const
{
  return d->pattern;
}

void FormatBackground::setPattern( unsigned pattern )
{
  d->pattern = pattern;
  d->null = false;
}

Color FormatBackground::backgroundColor() const
{
  return d->background;
}

void FormatBackground::setBackgroundColor( const Color& color )
{
  d->background = color;
  d->null = false;
}

Color FormatBackground::foregroundColor() const
{
  return d->foreground;
}

void FormatBackground::setForegroundColor( const Color& color )
{
  d->foreground = color;
  d->null = false;
}

bool FormatBackground::operator==(const FormatBackground& font) const
{
	return 
    d->pattern == font.d->pattern &&
    d->background == font.d->background &&
    d->foreground == font.d->foreground;
}

bool FormatBackground::operator!=(const FormatBackground& font) const
{
	return 
    d->pattern != font.d->pattern ||
    d->background != font.d->background ||
    d->foreground != font.d->foreground;
}

class FormatBorders::Private
{
public:
  bool null;
  Pen leftBorder;
  Pen rightBorder;
  Pen topBorder;
  Pen bottomBorder;
};

// constructor
FormatBorders::FormatBorders()
{
  d = new FormatBorders::Private;
  d->null = true;
}

// destructor
FormatBorders::~FormatBorders()
{
  delete d;
}

// copy constructor
FormatBorders::FormatBorders( const FormatBorders& border )
{
  d = new FormatBorders::Private;
  assign( border );
}

// assignment operator
FormatBorders& FormatBorders::operator=( const FormatBorders& border )
{
  return assign( border );
}

// assign from another alignment
FormatBorders& FormatBorders::assign( const FormatBorders& border )
{
  d->null         = border.isNull();
  d->leftBorder   = border.leftBorder();
  d->rightBorder  = border.rightBorder();
  d->topBorder    = border.topBorder();
  d->bottomBorder = border.bottomBorder();
  return *this;
}

bool FormatBorders::isNull() const
{
  return d->null;
}

const Pen& FormatBorders::leftBorder() const
{
  return d->leftBorder;
}

void FormatBorders::setLeftBorder( const Pen& pen )
{
  d->leftBorder = pen;
  d->null = false;
}

const Pen& FormatBorders::rightBorder() const
{
  return d->rightBorder;
}

void FormatBorders::setRightBorder( const Pen& pen )
{
  d->rightBorder = pen;
  d->null = false;
}

const Pen& FormatBorders::topBorder() const
{
  return d->topBorder;
}

void FormatBorders::setTopBorder( const Pen& pen )
{
  d->topBorder = pen;
  d->null = false;
}

const Pen& FormatBorders::bottomBorder() const
{
  return d->bottomBorder;
}

void FormatBorders::setBottomBorder( const Pen& pen )
{
  d->bottomBorder = pen;
  d->null = false;
}

bool FormatBorders::operator==(const FormatBorders& font) const
{
	return 
    d->leftBorder == font.d->leftBorder &&
    d->rightBorder == font.d->rightBorder &&
    d->topBorder == font.d->topBorder &&
    d->bottomBorder == font.d->bottomBorder;
}

bool FormatBorders::operator!=(const FormatBorders& font) const
{
	return 
    d->leftBorder != font.d->leftBorder ||
    d->rightBorder != font.d->rightBorder ||
    d->topBorder != font.d->topBorder ||
    d->bottomBorder != font.d->bottomBorder;
}

// helper class for Format class
class Format::Private
{
public:
  FormatFont font;
  FormatAlignment alignment;
  FormatBorders borders;
  FormatBackground background;
  UString valueFormat;
};

// create an empty format
Format::Format()
{
  d = new Format::Private;
  d->valueFormat = "General";
}

// destructor
Format::~Format()
{
  delete d;
}

// copy constructor
Format::Format( const Format& f )
{
  d = new Format::Private;
  assign( f );
}

// assignment operator
Format& Format::operator=( const Format& f )
{
  return assign( f );
}

// assign from another format
Format& Format::assign( const Format& f )
{
  d->font = f.font();
  d->alignment = f.alignment();
  d->borders = f.borders();
  d->valueFormat = f.valueFormat();
  d->background = f.background();
  return *this;
}

bool Format::isNull() const
{
  return d->font.isNull() && d->alignment.isNull() && d->borders.isNull();
}

FormatFont& Format::font() const
{
  return d->font;
}

void Format::setFont( const FormatFont& font )
{
  d->font = font;
}

FormatAlignment& Format::alignment() const
{
  return d->alignment;
}

void Format::setAlignment( const FormatAlignment& alignment )
{
  d->alignment = alignment;
}

FormatBorders& Format::borders() const
{
  return d->borders;
}

void Format::setBorders( const FormatBorders& borders )
{
  d->borders = borders;
}

FormatBackground& Format::background() const
{
  return d->background;
}

void Format::setBackground( const FormatBackground& background )
{
  d->background = background;
}

const UString& Format::valueFormat() const
{
  return d->valueFormat;
}

void Format::setValueFormat( const UString& valueFormat )
{
  d->valueFormat = valueFormat;
}

// merge f into current format
Format& Format::apply( const Format& f )
{
  if( !f.alignment().isNull() )
    alignment() = f.alignment();
  if( !f.font().isNull() )
    font() = f.font();
  if( !f.borders().isNull() )
    borders() = f.borders();
  if( f.valueFormat().isEmpty() || f.valueFormat() == "General" )
    setValueFormat( f.valueFormat() );
  if (!f.background().isNull() )
    background() = f.background();
  
  return *this;
}

bool Format::operator==(const Format& format) const
{
	return 
    d->font == format.d->font &&
    d->alignment == format.d->alignment &&
    d->borders == format.d->borders &&
    d->background == format.d->background &&
    d->valueFormat == format.d->valueFormat;
}

bool Format::operator!=(const Format& format) const
{
	return 
    d->font != format.d->font ||
    d->alignment != format.d->alignment ||
    d->borders != format.d->borders ||
    d->background != format.d->background ||
    d->valueFormat != format.d->valueFormat;
}