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.
202 lines
6.8 KiB
202 lines
6.8 KiB
/* This file is part of the KDE project
|
|
Copyright (c) 2003 Lukas Tinkl <lukas@kde.org>
|
|
Copyright (c) 2003 David Faure <faure@kde.org>
|
|
|
|
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 KOSTYLESTACK_H
|
|
#define KOSTYLESTACK_H
|
|
|
|
|
|
#include <tqvaluelist.h>
|
|
#include <tqdom.h>
|
|
#include <tqvaluestack.h>
|
|
|
|
#include <kdemacros.h>
|
|
|
|
#include "koffice_export.h"
|
|
|
|
/**
|
|
* @brief This class implements a stack for the different styles of an object.
|
|
*
|
|
* There can be several styles that are valid for one object. For example
|
|
* a textobject on a page has styles 'pr3' and 'P7' and a paragraph in
|
|
* that textobject has styles 'P1' and 'T3'. And some styles even have
|
|
* parent-styles...
|
|
*
|
|
* If you want to know if there is, for example, the attribute 'fo:font-family'
|
|
* for this paragraph, you have to look into style 'T3', 'P1', 'P7' and 'pr3'.
|
|
* When you find this attribute in one style you have to stop processing the list
|
|
* and take the found attribute for this object.
|
|
*
|
|
* This is what this class does. You can push styles on the stack while walking
|
|
* through the xml-tree to your object and then ask the stack if any of the styles
|
|
* provides a certain attribute. The stack will search from top to bottom, i.e.
|
|
* in our example from 'T3' to 'pr3' and return the first occurrence of the wanted
|
|
* attribute.
|
|
*
|
|
* So this is some sort of inheritance where the styles on top of the stack overwrite
|
|
* the same attribute of a lower style on the stack.
|
|
*
|
|
* In general though, you wouldn't use push/pop directly, but KoOasisLoadingContext::fillStyleStack
|
|
* or KoOasisLoadingContext::addStyles to automatically push a style and all its
|
|
* parent styles onto the stack.
|
|
*/
|
|
class KOFFICECORE_EXPORT KoStyleStack
|
|
{
|
|
public:
|
|
/**
|
|
* Create a OASIS style stack
|
|
*/
|
|
KoStyleStack();
|
|
/**
|
|
* Create a style stack based on other namespaces than OASIS - used for OOo-1.1 import.
|
|
*/
|
|
KoStyleStack( const char* styleNSURI, const char* foNSURI );
|
|
virtual ~KoStyleStack();
|
|
|
|
/**
|
|
* Clears the complete stack.
|
|
*/
|
|
void clear();
|
|
|
|
/**
|
|
* Save the current state of the stack. Any items added between
|
|
* this call and its corresponding restore() will be removed when calling restore().
|
|
*/
|
|
void save();
|
|
|
|
/**
|
|
* Restore the stack to the state it was at the corresponding save() call.
|
|
*/
|
|
void restore();
|
|
|
|
/**
|
|
* Removes the style on top of the stack.
|
|
*/
|
|
void pop();
|
|
|
|
/**
|
|
* Pushes the new style onto the stack.
|
|
*/
|
|
void push( const TQDomElement& style );
|
|
|
|
/**
|
|
* Check if any of the styles on the stack has an attribute called 'name'-'detail'
|
|
* where detail is e.g. left, right, top or bottom.
|
|
* This allows to also find 'name' alone (e.g. padding implies padding-left, padding-right etc.)
|
|
*/
|
|
bool hasAttribute( const TQString& name, const TQString& detail = TQString() ) const KDE_DEPRECATED;
|
|
|
|
/**
|
|
* Search for the attribute called 'name', starting on top of the stack,
|
|
* and return it.
|
|
*/
|
|
TQString attribute( const TQString& name, const TQString& detail = TQString() ) const KDE_DEPRECATED;
|
|
|
|
/**
|
|
* Check if any of the styles on the stack has an attribute called 'name'-'detail'
|
|
* where detail is e.g. left, right, top or bottom.
|
|
* This allows to also find 'name' alone (e.g. padding implies padding-left, padding-right etc.)
|
|
*/
|
|
bool hasAttributeNS( const char* nsURI, const char* localName, const char* detail = 0 ) const;
|
|
|
|
/**
|
|
* Search for the attribute called 'name', starting on top of the stack,
|
|
* and return it.
|
|
*/
|
|
TQString attributeNS( const char* nsURI, const char* localName, const char* detail = 0 ) const;
|
|
|
|
/**
|
|
* Check if any of the styles on the stack has a child node called 'name'.
|
|
*/
|
|
bool hasChildNode( const TQString & name ) const KDE_DEPRECATED;
|
|
|
|
/**
|
|
* Search for a child node called 'name', starting on top of the stack,
|
|
* and return it.
|
|
*/
|
|
TQDomElement childNode( const TQString & name ) const KDE_DEPRECATED;
|
|
|
|
/**
|
|
* Check if any of the styles on the stack has a child element called 'localName' in the namespace 'nsURI'.
|
|
*/
|
|
bool hasChildNodeNS( const char* nsURI, const char* localName ) const;
|
|
|
|
/**
|
|
* Search for a child element which has a child element called 'localName'
|
|
* in the namespace 'nsURI' starting on top of the stack,
|
|
* and return it.
|
|
*/
|
|
TQDomElement childNodeNS( const char* nsURI, const char* localName ) const;
|
|
|
|
/**
|
|
* Special case for the current font size, due to special handling of fo:font-size="115%".
|
|
*/
|
|
double fontSize() const;
|
|
|
|
/**
|
|
* Return the name of the style specified by the user,
|
|
* i.e. not an auto style.
|
|
* This is used to know e.g. which user-style is associated with the current paragraph.
|
|
* There could be none though.
|
|
*/
|
|
TQString userStyleName( const TQString& family ) const;
|
|
|
|
/**
|
|
* Return the display name of the style specified by the user,
|
|
* i.e. not an auto style
|
|
*/
|
|
TQString userStyleDisplayName( const TQString& family ) const;
|
|
|
|
/**
|
|
* Set the type of properties that will be looked for.
|
|
* For instance setTypeProperties("paragraph") will make hasAttribute() and attribute()
|
|
* look into "paragraph-properties".
|
|
* If @p typeProperties is 0, the stylestack is resetted to look for "properties"
|
|
* as it does by default.
|
|
*/
|
|
void setTypeProperties( const char* typeProperties );
|
|
|
|
private:
|
|
bool isUserStyle( const TQDomElement& e, const TQString& family ) const;
|
|
|
|
private:
|
|
/// For save/restore: stack of "marks". Each mark is an index in m_stack.
|
|
TQValueStack<int> m_marks;
|
|
|
|
/**
|
|
* We use TQValueList instead of TQValueStack because we need access to all styles
|
|
* not only the top one.
|
|
*/
|
|
TQValueList<TQDomElement> m_stack;
|
|
|
|
TQCString m_propertiesTagName;
|
|
|
|
const char* m_styleNSURI;
|
|
const char* m_foNSURI;
|
|
|
|
class KoStyleStackPrivate;
|
|
KoStyleStackPrivate *d;
|
|
|
|
// forbidden
|
|
void operator=( const KoStyleStack& );
|
|
KoStyleStack( const KoStyleStack& );
|
|
};
|
|
|
|
#endif /* KOSTYLESTACK_H */
|