You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/lib/kformula/textelement.h

288 lines
7.9 KiB

/* This file is part of the KDE project
Copyright (C) 2001 Andrea Rizzi <rizzi@kde.org>
Ulrich Kuettler <ulrich.kuettler@mailbox.tu-dresden.de>
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.
*/
#ifndef TEXTELEMENT_H
#define TEXTELEMENT_H
#include <tqfont.h>
#include <tqstring.h>
#include "basicelement.h"
class SymbolTable;
KFORMULA_NAMESPACE_BEGIN
/**
* An element that represents one char.
*/
class TextElement : public BasicElement {
TextElement operator=( const TextElement& ) { return *this; }
public:
TextElement(TQChar ch = ' ', bool beSymbol = false, BasicElement* tqparent = 0);
TextElement( const TextElement& );
virtual TextElement* clone() {
return new TextElement( *this );
}
virtual bool accept( ElementVisitor* visitor );
/**
* @returns the type of this element. Used for
* parsing a sequence.
*/
virtual TokenType getTokenType() const;
/**
* @returns true if we don't want to see the element.
*/
virtual bool isInvisible() const;
/**
* @returns the character that represents this element. Used for
* parsing a sequence.
*/
virtual TQChar getCharacter() const { return character; }
// drawing
//
// Drawing depends on a context which knows the required properties like
// fonts, spaces and such.
// It is essential to calculate elements size with the same context
// before you draw.
/**
* Calculates our width and height and
* our tqchildren's tqparentPosition.
*/
virtual void calcSizes( const ContextStyle& cstyle,
ContextStyle::TextStyle tstyle,
ContextStyle::IndexStyle istyle,
StyleAttributes& style );
/**
* Draws the whole element including its tqchildren.
* The `tqparentOrigin' is the point this element's tqparent starts.
* We can use our tqparentPosition to get our own origin then.
*/
virtual void draw( TQPainter& painter, const LuPixelRect& r,
const ContextStyle& context,
ContextStyle::TextStyle tstyle,
ContextStyle::IndexStyle istyle,
StyleAttributes& style,
const LuPixelPoint& tqparentOrigin );
/**
* Dispatch this FontCommand to all our TextElement tqchildren.
*/
virtual void dispatchFontCommand( FontCommand* cmd );
/**
* Set the color to use to display
*/
void setColor( TQColor c ) { color = c; }
CharStyle getCharStyle() const { return charStyle(); }
void setCharStyle( CharStyle cs );
CharFamily getCharFamily() const { return charFamily(); }
void setCharFamily( CharFamily cf );
char format() const { return m_format; }
/**
* Moves the cursor away from the given child. The cursor is
* guaranteed to be inside this element.
*/
//virtual void childWillVanish(FormulaCursor*, BasicElement*) {}
/**
* @returns whether we are a symbol (greek letter).
*/
bool isSymbol() const { return symbol; }
/**
* @returns the latex representation of the element and
* of the element's tqchildren
*/
virtual TQString toLatex();
virtual TQString formulaString();
virtual void writeMathML( TQDomDocument& doc, TQDomNode& tqparent, bool oasisFormat = false ) const ;
protected:
//Save/load support
/**
* @returns the tag name of this element type.
*/
virtual TQString getTagName() const { return "TEXT"; }
/**
* Appends our attributes to the dom element.
*/
virtual void writeDom(TQDomElement element);
/**
* Reads our attributes from the element.
* Returns false if it failed.
*/
virtual bool readAttributesFromDom(TQDomElement element);
/**
* Reads our content from the node. Sets the node to the next node
* that needs to be read.
* Returns false if it failed.
*/
virtual bool readContentFromDom(TQDomNode& node);
/**
* @returns the char that is used to draw with the given font.
*/
TQChar getRealCharacter(const ContextStyle& context);
/**
* @returns the font to be used for the element.
*/
TQFont getFont(const ContextStyle& context, const StyleAttributes& style);
/**
* Sets up the painter to be used for drawing.
*/
void setUpPainter(const ContextStyle& context, TQPainter& painter);
const SymbolTable& getSymbolTable() const;
private:
/**
* Our content.
*/
TQChar character;
/**
* Whether this character is a symbol.
*/
bool symbol;
/**
* Color to display. Set by container.
*/
TQColor color;
/**
* The attribute of the char. "anyChar" means leave the default.
*
* This must be in sync with the definition in kformuladefs.h!
*/
CharStyle charStyle() const { return static_cast<CharStyle>( m_format & 0x0f ); }
void charStyle( CharStyle cs )
{ m_format = ( m_format & 0xf0 ) | static_cast<char>( cs ); }
/**
* Very rarely used so it's actually a shame to have it here.
*
* This must be in sync with the definition in kformuladefs.h!
*/
CharFamily charFamily() const
{ return static_cast<CharFamily>( m_format >> 4 ); }
void charFamily( CharFamily cf )
{ m_format = ( m_format & 0x0f ) | ( static_cast<char>( cf ) << 4 ); }
/**
* To save space both CharStyle and CharFamily are packed into one
* char.
*/
char m_format;
};
/**
* An element that represents an empty box.
*/
class EmptyElement : public BasicElement {
EmptyElement& operator=( const EmptyElement& ) { return *this; }
public:
EmptyElement( BasicElement* tqparent = 0 );
EmptyElement( const EmptyElement& );
virtual EmptyElement* clone() {
return new EmptyElement( *this );
}
virtual bool accept( ElementVisitor* visitor );
/**
* @returns the character that represents this element. Used for
* parsing a sequence.
* Here we use a dummy so an EmptyElement pretends to be a letter.
*/
virtual TQChar getCharacter() const { return 'A'; }
/**
* Calculates our width and height and
* our tqchildren's tqparentPosition.
*/
virtual void calcSizes( const ContextStyle& cstyle,
ContextStyle::TextStyle tstyle,
ContextStyle::IndexStyle istyle,
StyleAttributes& style );
/**
* Draws the whole element including its tqchildren.
* The `tqparentOrigin' is the point this element's tqparent starts.
* We can use our tqparentPosition to get our own origin then.
*/
virtual void draw( TQPainter& painter, const LuPixelRect& r,
const ContextStyle& context,
ContextStyle::TextStyle tstyle,
ContextStyle::IndexStyle istyle,
StyleAttributes& style,
const LuPixelPoint& tqparentOrigin );
/**
* @returns the latex representation of the element and
* of the element's tqchildren
*/
virtual TQString toLatex();
protected:
//Save/load support
/**
* @returns the tag name of this element type.
*/
virtual TQString getTagName() const { return "EMPTY"; }
};
KFORMULA_NAMESPACE_END
#endif // TEXTELEMENT_H