WP6Listener.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
00002 /* libwpd
00003  * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
00004  * Copyright (C) 2002 Marc Maurer (uwog@uwog.net)
00005  * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
00006  *
00007  * This library is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU Library General Public
00009  * License as published by the Free Software Foundation; either
00010  * version 2 of the License, or (at your option) any later version.
00011  *
00012  * This library is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015  * Library General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU Library General Public
00018  * License along with this library; if not, write to the Free Software
00019  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
00020  *
00021  * For further information visit http://libwpd.sourceforge.net
00022  */
00023 
00024 /* "This product is not manufactured, approved, or supported by
00025  * Corel Corporation or Corel Corporation Limited."
00026  */
00027 
00028 #ifndef WP6LISTENER_H
00029 #define WP6LISTENER_H
00030 
00031 #include "libwpd_internal.h"
00032 #include <vector>
00033 
00034 class WPXString;
00035 class WP6DefaultInitialFontPacket;
00036 class WP6PrefixData;
00037 class WP6PrefixDataPacket;
00038 class WP6SubDocument;
00039 
00040 enum WP6OutlineLocation { paragraphGroup, indexHeader };
00041 
00042 class WP6Listener
00043 {
00044 public:
00045         WP6Listener();
00046         virtual ~WP6Listener() {};
00047 
00048         virtual void startDocument() = 0;
00049         virtual void startSubDocument() = 0;
00050         virtual void setDate(const uint16_t type, const uint16_t year,
00051                              const uint8_t month, const uint8_t day,
00052                              const uint8_t hour, const uint8_t minute,
00053                              const uint8_t second, const uint8_t dayOfWeek,
00054                              const uint8_t timeZone, const uint8_t unused) = 0;
00055         virtual void setExtendedInformation(const uint16_t type, const WPXString &data) = 0;
00056         virtual void setAlignmentCharacter(const uint16_t character) = 0;
00057         virtual void setLeaderCharacter(const uint16_t character, const uint8_t numSpaces) = 0;
00058         virtual void defineTabStops(const bool isRelative, const std::vector<WPXTabStop> &tabStops,
00059                                     const std::vector<bool> &usePreWP9LeaderMethods) = 0;
00060         virtual void insertCharacter(uint32_t character) = 0;
00061         virtual void insertTab(const uint8_t tabType, double tabPosition) = 0;
00062         virtual void handleLineBreak() = 0;
00063         virtual void insertEOL() = 0;
00064         virtual void insertBreak(const uint8_t breakType) = 0;
00065         virtual void lineSpacingChange(const double lineSpacing) = 0;
00066         virtual void justificationChange(const uint8_t justification) = 0;
00067         virtual void characterColorChange(const uint8_t red, const uint8_t green, const uint8_t blue) = 0;
00068         virtual void characterShadingChange(const uint8_t shading) = 0;
00069         virtual void highlightChange(const bool isOn, const RGBSColor color) = 0;
00070         virtual void fontChange(const uint16_t matchedFontPointSize, const uint16_t fontPID, const WPXString &fontName) = 0;
00071         virtual void attributeChange(const bool isOn, const uint8_t attribute) = 0;
00072         virtual void spacingAfterParagraphChange(const double spacingRelative, const double spacingAbsolute) = 0;
00073         virtual void pageMarginChange(const uint8_t side, const uint16_t margin) = 0;
00074         virtual void pageFormChange(const uint16_t length, const uint16_t width, const WPXFormOrientation orientation) = 0;
00075         virtual void pageNumberingChange(const WPXPageNumberPosition pageNumberPosition, const uint16_t pageNumberFontPointSize, const uint16_t pageNumberFontPID) = 0;
00076         virtual void marginChange(const uint8_t side, const uint16_t margin) = 0;
00077         virtual void paragraphMarginChange(const uint8_t side, const int16_t margin) = 0;
00078         virtual void indentFirstLineChange(const int16_t offset) = 0;
00079         virtual void columnChange(const WPXTextColumnType columnType, const uint8_t numColumns,
00080                                   const std::vector<double> &columnWidth, const std::vector<bool> &isFixedWidth) = 0;
00081         virtual void updateOutlineDefinition(const WP6OutlineLocation outlineLocation, const uint16_t outlineHash,
00082                                              const uint8_t *numberingMethods, const uint8_t tabBehaviourFlag) = 0;
00083         virtual void paragraphNumberOn(const uint16_t outlineHash, const uint8_t level, const uint8_t flag) = 0;
00084         virtual void paragraphNumberOff() = 0;
00085         virtual void displayNumberReferenceGroupOn(const uint8_t subGroup, const uint8_t level) = 0;
00086         virtual void displayNumberReferenceGroupOff(const uint8_t subGroup) = 0;
00087         virtual void styleGroupOn(const uint8_t subGroup) = 0;
00088         virtual void styleGroupOff(const uint8_t subGroup) = 0;
00089         virtual void globalOn(const uint8_t systemStyle) = 0;
00090         virtual void globalOff() = 0;
00091         virtual void noteOn(const uint16_t textPID) = 0;
00092         virtual void noteOff(const WPXNoteType noteType) = 0;
00093         virtual void headerFooterGroup(const uint8_t headerFooterType, const uint8_t occurenceBits, const uint16_t textPID) = 0;
00094         virtual void suppressPageCharacteristics(const uint8_t suppressCode) = 0;
00095         virtual void setPageNumber(const uint16_t pageNumber) = 0;
00096         virtual void setPageNumberingType(const WPXNumberingType pageNumberingType) = 0;
00097         virtual void endDocument() = 0;
00098         virtual void endSubDocument() = 0;
00099         virtual void defineTable(const uint8_t position, const uint16_t leftOffset) = 0;
00100         virtual void addTableColumnDefinition(const uint32_t width, const uint32_t leftGutter, const uint32_t rightGutter,
00101                                               const uint32_t attributes, const uint8_t alignment) = 0;
00102         virtual void startTable() = 0;
00103         virtual void insertRow(const uint16_t rowHeight, const bool isMinimumHeight, const bool isHeaderRow) = 0;
00104         virtual void insertCell(const uint8_t colSpan, const uint8_t rowSpan, const uint8_t borderBits,
00105                                 const RGBSColor *cellFgColor, const RGBSColor *cellBgColor,
00106                                 const RGBSColor *cellBorderColor, const WPXVerticalAlignment cellVerticalAlignment,
00107                                 const bool useCellAttributes, const uint32_t cellAttributes) = 0;
00108         virtual void endTable() = 0;
00109 
00110         virtual void undoChange(const uint8_t undoType, const uint16_t undoLevel) = 0;
00111         virtual void boxOn(const uint8_t anchoringType, const uint8_t generalPositioningFlags, const uint8_t horizontalPositioningFlags,
00112                            const int16_t horizontalOffset, const uint8_t leftColumn, const uint8_t rightColumn,
00113                            const uint8_t verticalPositioningFlags, const int16_t verticalOffset, const uint8_t widthFlags, const uint16_t width,
00114                            const uint8_t heightFlags, const uint16_t height, const uint8_t boxContentType, const uint16_t nativeWidth,
00115                            const uint16_t nativeHeight) = 0;
00116         virtual void boxOff() = 0;
00117         virtual void insertGraphicsData(const uint16_t packetId) = 0;
00118         virtual void insertTextBox(const WP6SubDocument *subDocument) = 0;
00119         virtual void commentAnnotation(const uint16_t textPID) = 0;
00120 
00121         void setPrefixData(WP6PrefixData *prefixData)
00122         {
00123                 m_prefixData = prefixData;
00124         }
00125         const WP6PrefixDataPacket *getPrefixDataPacket(const int prefixID) const;
00126         WPXString getFontNameForPID(const int prefixID) const;
00127 
00128 private:
00129         WP6Listener(const WP6Listener &);
00130         WP6Listener &operator=(const WP6Listener &);
00131         WP6PrefixData *m_prefixData;
00132 };
00133 
00134 #endif /* WP6LISTENER_H */
00135 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */