sc/source/filter/inc/xlescher.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SC_SOURCE_FILTER_INC_XLESCHER_HXX
  21 #define INCLUDED_SC_SOURCE_FILTER_INC_XLESCHER_HXX
  22
  23 #include <tools/gen.hxx>
  24 #include <tools/mapunit.hxx>
  25 #include "xladdress.hxx"
  26 #include "xlstyle.hxx"
  27 #include "xistream.hxx"
  28
  29 namespace com { namespace sun { namespace star {
  30     namespace drawing { class XShape; }
  31     namespace awt { class XControlModel; }
  32     namespace script { struct ScriptEventDescriptor; }
  33 } } }
  34
  35 // Constants and Enumerations =================================================
  36
  37 // (0x001C) NOTE --------------------------------------------------------------
  38
  39 const sal_uInt16 EXC_ID_NOTE                = 0x001C;
  40 const sal_uInt16 EXC_NOTE_VISIBLE           = 0x0002;
  41 const sal_uInt16 EXC_NOTE5_MAXLEN           = 2048;
  42
  43 // (0x005D) OBJ ---------------------------------------------------------------
  44
  45 const sal_uInt16 EXC_ID_OBJ                 = 0x005D;
  46
  47 const sal_uInt16 EXC_OBJ_INVALID_ID         = 0;
  48
  49 // object types
  50 const sal_uInt16 EXC_OBJTYPE_GROUP          = 0;
  51 const sal_uInt16 EXC_OBJTYPE_LINE           = 1;
  52 const sal_uInt16 EXC_OBJTYPE_RECTANGLE      = 2;
  53 const sal_uInt16 EXC_OBJTYPE_OVAL           = 3;
  54 const sal_uInt16 EXC_OBJTYPE_ARC            = 4;
  55 const sal_uInt16 EXC_OBJTYPE_CHART          = 5;
  56 const sal_uInt16 EXC_OBJTYPE_TEXT           = 6;
  57 const sal_uInt16 EXC_OBJTYPE_BUTTON         = 7;
  58 const sal_uInt16 EXC_OBJTYPE_PICTURE        = 8;
  59 const sal_uInt16 EXC_OBJTYPE_POLYGON        = 9;        // new in BIFF4
  60 const sal_uInt16 EXC_OBJTYPE_CHECKBOX       = 11;       // new in BIFF5
  61 const sal_uInt16 EXC_OBJTYPE_OPTIONBUTTON   = 12;
  62 const sal_uInt16 EXC_OBJTYPE_EDIT           = 13;
  63 const sal_uInt16 EXC_OBJTYPE_LABEL          = 14;
  64 const sal_uInt16 EXC_OBJTYPE_DIALOG         = 15;
  65 const sal_uInt16 EXC_OBJTYPE_SPIN           = 16;
  66 const sal_uInt16 EXC_OBJTYPE_SCROLLBAR      = 17;
  67 const sal_uInt16 EXC_OBJTYPE_LISTBOX        = 18;
  68 const sal_uInt16 EXC_OBJTYPE_GROUPBOX       = 19;
  69 const sal_uInt16 EXC_OBJTYPE_DROPDOWN       = 20;
  70 const sal_uInt16 EXC_OBJTYPE_NOTE           = 25;       // new in BIFF8
  71 const sal_uInt16 EXC_OBJTYPE_DRAWING        = 30;
  72 const sal_uInt16 EXC_OBJTYPE_UNKNOWN        = 0xFFFF;   /// For internal use only.
  73
  74 // BIFF3-BIFF5 flags
  75 const sal_uInt16 EXC_OBJ_HIDDEN             = 0x0100;
  76 const sal_uInt16 EXC_OBJ_VISIBLE            = 0x0200;
  77 const sal_uInt16 EXC_OBJ_PRINTABLE          = 0x0400;
  78
  79 // BIFF5 line formatting
  80 const sal_uInt8 EXC_OBJ_LINE_AUTOCOLOR      = 64;
  81
  82 const sal_uInt8 EXC_OBJ_LINE_SOLID          = 0;
  83 const sal_uInt8 EXC_OBJ_LINE_DASH           = 1;
  84 const sal_uInt8 EXC_OBJ_LINE_DOT            = 2;
  85 const sal_uInt8 EXC_OBJ_LINE_DASHDOT        = 3;
  86 const sal_uInt8 EXC_OBJ_LINE_DASHDOTDOT     = 4;
  87 const sal_uInt8 EXC_OBJ_LINE_MEDTRANS       = 5;
  88 const sal_uInt8 EXC_OBJ_LINE_DARKTRANS      = 6;
  89 const sal_uInt8 EXC_OBJ_LINE_LIGHTTRANS     = 7;
  90 const sal_uInt8 EXC_OBJ_LINE_NONE           = 255;
  91
  92 const sal_uInt8 EXC_OBJ_LINE_HAIR           = 0;
  93 const sal_uInt8 EXC_OBJ_LINE_THIN           = 1;
  94 const sal_uInt8 EXC_OBJ_LINE_MEDIUM         = 2;
  95 const sal_uInt8 EXC_OBJ_LINE_THICK          = 3;
  96
  97 const sal_uInt8 EXC_OBJ_LINE_AUTO           = 0x01;
  98
  99 const sal_uInt8 EXC_OBJ_ARROW_NONE          = 0;
 100 const sal_uInt8 EXC_OBJ_ARROW_OPEN          = 1;
 101 const sal_uInt8 EXC_OBJ_ARROW_FILLED        = 2;
 102 const sal_uInt8 EXC_OBJ_ARROW_OPENBOTH      = 3;
 103 const sal_uInt8 EXC_OBJ_ARROW_FILLEDBOTH    = 4;
 104
 105 const sal_uInt8 EXC_OBJ_ARROW_NARROW        = 0;
 106 const sal_uInt8 EXC_OBJ_ARROW_MEDIUM        = 1;
 107 const sal_uInt8 EXC_OBJ_ARROW_WIDE          = 2;
 108
 109 const sal_uInt8 EXC_OBJ_LINE_TL             = 0;
 110 const sal_uInt8 EXC_OBJ_LINE_TR             = 1;
 111 const sal_uInt8 EXC_OBJ_LINE_BR             = 2;
 112 const sal_uInt8 EXC_OBJ_LINE_BL             = 3;
 113
 114 // BIFF5 fill formatting
 115 const sal_uInt8 EXC_OBJ_FILL_AUTOCOLOR      = 65;
 116
 117 const sal_uInt8 EXC_OBJ_FILL_AUTO           = 0x01;
 118
 119 // BIFF5 frame formatting
 120 const sal_uInt16 EXC_OBJ_FRAME_SHADOW       = 0x0002;
 121
 122 // BIFF5 text objects
 123 const sal_uInt8 EXC_OBJ_HOR_LEFT            = 1;
 124 const sal_uInt8 EXC_OBJ_HOR_CENTER          = 2;
 125 const sal_uInt8 EXC_OBJ_HOR_RIGHT           = 3;
 126 const sal_uInt8 EXC_OBJ_HOR_JUSTIFY         = 4;
 127
 128 const sal_uInt8 EXC_OBJ_VER_TOP             = 1;
 129 const sal_uInt8 EXC_OBJ_VER_CENTER          = 2;
 130 const sal_uInt8 EXC_OBJ_VER_BOTTOM          = 3;
 131 const sal_uInt8 EXC_OBJ_VER_JUSTIFY         = 4;
 132
 133 const sal_uInt16 EXC_OBJ_ORIENT_NONE        = 0;
 134 const sal_uInt16 EXC_OBJ_ORIENT_STACKED     = 1;        /// Stacked top to bottom.
 135 const sal_uInt16 EXC_OBJ_ORIENT_90CCW       = 2;        /// 90 degr. counterclockwise.
 136 const sal_uInt16 EXC_OBJ_ORIENT_90CW        = 3;        /// 90 degr. clockwise.
 137
 138 const sal_uInt16 EXC_OBJ_TEXT_AUTOSIZE      = 0x0080;
 139 const sal_uInt16 EXC_OBJ_TEXT_LOCKED        = 0x0200;
 140
 141 const sal_Int32 EXC_OBJ_TEXT_MARGIN         = 20000;    /// Automatic text margin (EMUs).
 142
 143 // BIFF5 arc objects
 144 const sal_uInt8 EXC_OBJ_ARC_TR              = 0;
 145 const sal_uInt8 EXC_OBJ_ARC_TL              = 1;
 146 const sal_uInt8 EXC_OBJ_ARC_BL              = 2;
 147 const sal_uInt8 EXC_OBJ_ARC_BR              = 3;
 148
 149 // BIFF5 polygon objects
 150 const sal_uInt16 EXC_OBJ_POLY_CLOSED        = 0x0100;
 151
 152 // BIFF5 pictures/OLE objects
 153 const sal_uInt16 EXC_OBJ_PIC_MANUALSIZE     = 0x0001;
 154 const sal_uInt16 EXC_OBJ_PIC_DDE            = 0x0002;
 155 const sal_uInt16 EXC_OBJ_PIC_SYMBOL         = 0x0008;
 156 const sal_uInt16 EXC_OBJ_PIC_CONTROL        = 0x0010;   /// Form control (BIFF8).
 157 const sal_uInt16 EXC_OBJ_PIC_CTLSSTREAM     = 0x0020;   /// Data in Ctls stream (BIFF8).
 158 const sal_uInt16 EXC_OBJ_PIC_AUTOLOAD       = 0x0200;   /// Auto-load form control (BIFF8).
 159
 160 // BIFF5 button objects
 161 const sal_uInt16 EXC_OBJ_BUTTON_DEFAULT     = 0x0001;
 162 const sal_uInt16 EXC_OBJ_BUTTON_HELP        = 0x0002;
 163 const sal_uInt16 EXC_OBJ_BUTTON_CANCEL      = 0x0004;
 164 const sal_uInt16 EXC_OBJ_BUTTON_CLOSE       = 0x0008;
 165
 166 // BIFF5 checkboxes, radio buttons
 167 const sal_uInt16 EXC_OBJ_CHECKBOX_UNCHECKED = 0;
 168 const sal_uInt16 EXC_OBJ_CHECKBOX_CHECKED   = 1;
 169 const sal_uInt16 EXC_OBJ_CHECKBOX_TRISTATE  = 2;
 170 const sal_uInt16 EXC_OBJ_CHECKBOX_FLAT      = 0x0001;
 171
 172 // BIFF5 editbox objects
 173 const sal_uInt16 EXC_OBJ_EDIT_TEXT          = 0;
 174 const sal_uInt16 EXC_OBJ_EDIT_INTEGER       = 1;
 175 const sal_uInt16 EXC_OBJ_EDIT_DOUBLE        = 2;
 176 const sal_uInt16 EXC_OBJ_EDIT_REFERENCE     = 3;
 177 const sal_uInt16 EXC_OBJ_EDIT_FORMULA       = 4;
 178
 179 // BIFF5 scrollbars/spinbuttons
 180 const sal_uInt16 EXC_OBJ_SCROLLBAR_MIN      = 0;
 181 const sal_uInt16 EXC_OBJ_SCROLLBAR_MAX      = 30000;
 182
 183 const sal_uInt16 EXC_OBJ_SCROLLBAR_HOR      = 0x0001;
 184
 185 const sal_uInt16 EXC_OBJ_SCROLLBAR_DEFFLAGS = 0x0001;
 186 const sal_uInt16 EXC_OBJ_SCROLLBAR_FLAT     = 0x0008;
 187
 188 // BIFF5 listboxes/dropdowns
 189 const sal_uInt8 EXC_OBJ_LISTBOX_SINGLE      = 0;        /// Single selection.
 190 const sal_uInt8 EXC_OBJ_LISTBOX_MULTI       = 1;        /// Multi selection.
 191 const sal_uInt8 EXC_OBJ_LISTBOX_RANGE       = 2;        /// Range selection.
 192
 193 const sal_uInt16 EXC_OBJ_LISTBOX_EDIT       = 0x0002;
 194 const sal_uInt16 EXC_OBJ_LISTBOX_FLAT       = 0x0008;
 195
 196 // BIFF5 dropdown listboxes
 197 const sal_uInt16 EXC_OBJ_DROPDOWN_LISTBOX   = 0;        /// Listbox, text not editable.
 198 const sal_uInt16 EXC_OBJ_DROPDOWN_COMBOBOX  = 1;        /// Dropdown listbox with editable text.
 199 const sal_uInt16 EXC_OBJ_DROPDOWN_SIMPLE    = 2;        /// Dropdown button only, no text area.
 200 const sal_uInt16 EXC_OBJ_DROPDOWN_MAX       = 3;
 201 const sal_uInt16 EXC_OBJ_DROPDOWN_FILTERED  = 0x0008;   /// Dropdown style: filtered.
 202
 203 // BIFF5 groupboxes
 204 const sal_uInt16 EXC_OBJ_GROUPBOX_FLAT      = 0x0001;
 205
 206 // BIFF8 sub records
 207 const sal_uInt16 EXC_ID_OBJEND              = 0x0000;   /// End of OBJ.
 208 const sal_uInt16 EXC_ID_OBJMACRO            = 0x0004;   /// Macro link.
 209 const sal_uInt16 EXC_ID_OBJBUTTON           = 0x0005;   /// Button data.
 210 const sal_uInt16 EXC_ID_OBJGMO              = 0x0006;   /// Group marker.
 211 const sal_uInt16 EXC_ID_OBJCF               = 0x0007;   /// Clipboard format.
 212 const sal_uInt16 EXC_ID_OBJFLAGS            = 0x0008;   /// Option flags.
 213 const sal_uInt16 EXC_ID_OBJPICTFMLA         = 0x0009;   /// OLE link formula.
 214 const sal_uInt16 EXC_ID_OBJCBLS             = 0x000A;   /// Check box/radio button data.
 215 const sal_uInt16 EXC_ID_OBJRBO              = 0x000B;   /// Radio button group data.
 216 const sal_uInt16 EXC_ID_OBJSBS              = 0x000C;   /// Scroll bar data.
 217 const sal_uInt16 EXC_ID_OBJNTS              = 0x000D;   /// Note data.
 218 const sal_uInt16 EXC_ID_OBJSBSFMLA          = 0x000E;   /// Scroll bar/list box/combo box cell link.
 219 const sal_uInt16 EXC_ID_OBJGBODATA          = 0x000F;   /// Group box data.
 220 const sal_uInt16 EXC_ID_OBJEDODATA          = 0x0010;   /// Edit box data.
 221 const sal_uInt16 EXC_ID_OBJRBODATA          = 0x0011;   /// Radio button group data.
 222 const sal_uInt16 EXC_ID_OBJCBLSDATA         = 0x0012;   /// Check box/radio button data.
 223 const sal_uInt16 EXC_ID_OBJLBSDATA          = 0x0013;   /// List box/combo box data.
 224 const sal_uInt16 EXC_ID_OBJCBLSFMLA         = 0x0014;   /// Check box/radio button cell link.
 225 const sal_uInt16 EXC_ID_OBJCMO              = 0x0015;   /// Common object settings.
 226 const sal_uInt16 EXC_ID_OBJUNKNOWN          = 0xFFFF;   /// For internal use only.
 227
 228 // BIFF8 OBJCMO: flags
 229 const sal_uInt16 EXC_OBJCMO_PRINTABLE       = 0x0010;   /// Object printable.
 230 const sal_uInt16 EXC_OBJCMO_AUTOLINE        = 0x2000;   /// Automatic line formatting.
 231 const sal_uInt16 EXC_OBJCMO_AUTOFILL        = 0x4000;   /// Automatic fill formatting.
 232
 233 /** Value binding mode for cells linked to form controls. */
 234 enum XclCtrlBindMode
 235 {
 236     EXC_CTRL_BINDCONTENT,       /// Binds cell to content of control.
 237     EXC_CTRL_BINDPOSITION       /// Binds cell to position in control (e.g. listbox selection index).
 238 };
 239
 240 // (0x007F) IMGDATA -----------------------------------------------------------
 241
 242 const sal_uInt16 EXC_ID3_IMGDATA            = 0x007F;
 243 const sal_uInt16 EXC_ID8_IMGDATA            = 0x00E9;
 244
 245 const sal_uInt16 EXC_IMGDATA_WMF            = 2;
 246 const sal_uInt16 EXC_IMGDATA_BMP            = 9;
 247
 248 const sal_uInt16 EXC_IMGDATA_WIN            = 1;
 249 const sal_uInt16 EXC_IMGDATA_MAC            = 2;
 250
 251 const sal_uInt32 EXC_IMGDATA_MAXREC8        = 0x201C;
 252 const sal_uInt32 EXC_IMGDATA_MAXCONT8       = 0x2014;
 253
 254 // (0x00A9) COORDLIST ---------------------------------------------------------
 255
 256 const sal_uInt16 EXC_ID_COORDLIST           = 0x00A9;
 257
 258 // (0x00EB) MSODRAWINGGROUP ---------------------------------------------------
 259
 260 const sal_uInt16 EXC_ID_MSODRAWINGGROUP     = 0x00EB;
 261
 262 // (0x00EC) MSODRAWING --------------------------------------------------------
 263
 264 const sal_uInt16 EXC_ID_MSODRAWING          = 0x00EC;
 265
 266 // additional flags not extant in svx headers
 267 const sal_uInt16 EXC_ESC_ANCHOR_POSLOCKED   = 0x0001;
 268 const sal_uInt16 EXC_ESC_ANCHOR_SIZELOCKED  = 0x0002;
 269 const sal_uInt16 EXC_ESC_ANCHOR_LOCKED      = EXC_ESC_ANCHOR_POSLOCKED|EXC_ESC_ANCHOR_SIZELOCKED;
 270
 271 // (0x00ED) MSODRAWINGSELECTION -----------------------------------------------
 272
 273 const sal_uInt16 EXC_ID_MSODRAWINGSEL       = 0x00ED;
 274
 275 // (0x01B6) TXO ---------------------------------------------------------------
 276
 277 const sal_uInt16 EXC_ID_TXO                 = 0x01B6;
 278
 279 // TXO constants are equal to BIFF5 OBJ text object flags
 280
 281 // Structs and classes ========================================================
 282
 283 /** Represents the position (anchor) of an object in a Calc document. */
 284 struct XclObjAnchor : public XclRange
 285 {
 286     sal_uInt16          mnLX;       /// X offset in left column (1/1024 of column width).
 287     sal_uInt32          mnTY;       /// Y offset in top row (1/256 of row height).
 288     sal_uInt16          mnRX;       /// X offset in right column (1/1024 of column width).
 289     sal_uInt32          mnBY;       /// Y offset in bottom row (1/256 of row height).
 290
 291     explicit            XclObjAnchor();
 292
 293     /** Calculates a rectangle from the contained coordinates. */
 294     tools::Rectangle           GetRect( const XclRoot& rRoot, SCTAB nScTab, MapUnit eMapUnit ) const;
 295     /** Initializes the anchor coordinates for a sheet. */
 296     void                SetRect( const XclRoot& rRoot, SCTAB nScTab, const tools::Rectangle& rRect, MapUnit eMapUnit );
 297
 298     /** Initializes the anchor coordinates for an embedded draw page. */
 299     void                SetRect( const Size& rPageSize, sal_Int32 nScaleX, sal_Int32 nScaleY,
 300                             const tools::Rectangle& rRect, MapUnit eMapUnit );
 301 };
 302
 303 inline SvStream& operator>>( SvStream& rStrm, XclObjAnchor& rAnchor )
 304 {
 305     sal_uInt16 tmpFirstRow, tmpTY, tmpLastRow, tmpBY;
 306
 307     rStrm
 308        .ReadUInt16( rAnchor.maFirst.mnCol ).ReadUInt16( rAnchor.mnLX )
 309        .ReadUInt16( tmpFirstRow ).ReadUInt16( tmpTY )
 310        .ReadUInt16( rAnchor.maLast.mnCol ).ReadUInt16( rAnchor.mnRX )
 311        .ReadUInt16( tmpLastRow ).ReadUInt16( tmpBY );
 312
 313     rAnchor.maFirst.mnRow = static_cast<sal_uInt32> (tmpFirstRow);
 314     rAnchor.mnTY = static_cast<sal_uInt32> (tmpTY);
 315     rAnchor.maLast.mnRow = static_cast<sal_uInt32> (tmpLastRow);
 316     rAnchor.mnBY = static_cast<sal_uInt32> (tmpBY);
 317
 318     return rStrm;
 319 }
 320
 321 inline XclImpStream& operator>>( XclImpStream& rStrm, XclObjAnchor& rAnchor )
 322 {
 323     sal_uInt16 tmpFirstRow, tmpTY, tmpLastRow, tmpBY;
 324
 325     rAnchor.maFirst.mnCol = rStrm.ReaduInt16();
 326     rAnchor.mnLX = rStrm.ReaduInt16();
 327     tmpFirstRow = rStrm.ReaduInt16();
 328     tmpTY = rStrm.ReaduInt16();
 329     rAnchor.maLast.mnCol = rStrm.ReaduInt16();
 330     rAnchor.mnRX = rStrm.ReaduInt16();
 331     tmpLastRow = rStrm.ReaduInt16();
 332     tmpBY = rStrm.ReaduInt16();
 333
 334     rAnchor.maFirst.mnRow = static_cast<sal_uInt32> (tmpFirstRow);
 335     rAnchor.mnTY = static_cast<sal_uInt32> (tmpTY);
 336     rAnchor.maLast.mnRow = static_cast<sal_uInt32> (tmpLastRow);
 337     rAnchor.mnBY = static_cast<sal_uInt32> (tmpBY);
 338
 339     return rStrm;
 340 }
 341
 342 inline SvStream& WriteXclObjAnchor( SvStream& rStrm, const XclObjAnchor& rAnchor )
 343 {
 344     return rStrm
 345           .WriteUInt16( rAnchor.maFirst.mnCol ).WriteUInt16( rAnchor.mnLX )
 346           .WriteUInt16( rAnchor.maFirst.mnRow ).WriteUInt16( rAnchor.mnTY )
 347           .WriteUInt16( rAnchor.maLast.mnCol ).WriteUInt16( rAnchor.mnRX )
 348           .WriteUInt16( rAnchor.maLast.mnRow).WriteUInt16(rAnchor.mnBY);
 349 }
 350
 351 struct XclObjLineData
 352 {
 353     sal_uInt8           mnColorIdx;
 354     sal_uInt8           mnStyle;
 355     sal_uInt8           mnWidth;
 356     sal_uInt8           mnAuto;
 357
 358     explicit            XclObjLineData();
 359
 360     bool         IsAuto() const { return ::get_flag( mnAuto, EXC_OBJ_LINE_AUTO ); }
 361     bool         IsVisible() const { return IsAuto() || (mnStyle != EXC_OBJ_LINE_NONE); }
 362 };
 363
 364 XclImpStream& operator>>( XclImpStream& rStrm, XclObjLineData& rLineData );
 365
 366 struct XclObjFillData
 367 {
 368     sal_uInt8           mnBackColorIdx;
 369     sal_uInt8           mnPattColorIdx;
 370     sal_uInt8           mnPattern;
 371     sal_uInt8           mnAuto;
 372
 373     explicit            XclObjFillData();
 374
 375     bool         IsAuto() const { return ::get_flag( mnAuto, EXC_OBJ_FILL_AUTO ); }
 376     bool         IsFilled() const { return IsAuto() || (mnPattern != EXC_PATT_NONE); }
 377 };
 378
 379 XclImpStream& operator>>( XclImpStream& rStrm, XclObjFillData& rFillData );
 380
 381 struct XclObjTextData
 382 {
 383     sal_uInt16          mnTextLen;
 384     sal_uInt16          mnFormatSize;
 385     sal_uInt16          mnLinkSize;
 386     sal_uInt16          mnDefFontIdx;
 387     sal_uInt16          mnFlags;
 388     sal_uInt16          mnOrient;
 389     sal_uInt16          mnButtonFlags;
 390     sal_uInt16          mnShortcut;
 391     sal_uInt16          mnShortcutEA;
 392
 393     explicit            XclObjTextData();
 394
 395     /** Reads text data from a BIFF3/BIFF4 OBJ record. */
 396     void                ReadObj3( XclImpStream& rStrm );
 397     /** Reads text data from a BIFF5 OBJ record. */
 398     void                ReadObj5( XclImpStream& rStrm );
 399     /** Reads text data from a BIFF8 TXO record. */
 400     void                ReadTxo8( XclImpStream& rStrm );
 401
 402     sal_uInt8    GetHorAlign() const { return ::extract_value< sal_uInt8 >( mnFlags, 1, 3 ); }
 403     sal_uInt8    GetVerAlign() const { return ::extract_value< sal_uInt8 >( mnFlags, 4, 3 ); }
 404 };
 405
 406 enum XclTbxEventType
 407 {
 408     EXC_TBX_EVENT_ACTION,       /// XActionListener.actionPerformed
 409     EXC_TBX_EVENT_MOUSE,        /// XMouseListener.mouseReleased
 410     EXC_TBX_EVENT_TEXT,         /// XTextListener.textChanged
 411     EXC_TBX_EVENT_VALUE,        /// XAdjustmentListener.adjustmentValueChanged
 412     EXC_TBX_EVENT_CHANGE        /// XChangeListener.changed
 413 };
 414
 415 /** Provides static helper functions for form controls. */
 416 class XclControlHelper
 417 {
 418 public:
 419     /** Returns the API control model from the passed API shape object. */
 420     static css::uno::Reference< css::awt::XControlModel >
 421                         GetControlModel( css::uno::Reference< css::drawing::XShape > const & xShape );
 422
 423     /** Fills the macro descriptor according to the passed macro name. */
 424     static bool         FillMacroDescriptor(
 425                             css::script::ScriptEventDescriptor& rDescriptor,
 426                             XclTbxEventType eEventType,
 427                             const OUString& rXclMacroName,
 428                             SfxObjectShell* pDocShell );
 429     /** Tries to extract an Excel macro name from the passed macro descriptor. */
 430     static OUString     ExtractFromMacroDescriptor(
 431                             const css::script::ScriptEventDescriptor& rDescriptor,
 432                             XclTbxEventType eEventType );
 433 };
 434
 435 #endif
 436
 437 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */