include/svx/xtable.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 #ifndef INCLUDED_SVX_XTABLE_HXX
  20 #define INCLUDED_SVX_XTABLE_HXX
  21
  22 #include <rtl/ref.hxx>
  23 #include <rtl/ustring.hxx>
  24 #include <svx/xpoly.hxx>
  25 #include <svx/xdash.hxx>
  26 #include <svx/xhatch.hxx>
  27 #include <svx/xgrad.hxx>
  28 #include <svx/xflasit.hxx>
  29 #include <svx/xlnasit.hxx>
  30
  31 #include <tools/color.hxx>
  32 #include <tools/contnr.hxx>
  33
  34 #include <cppuhelper/weak.hxx>
  35
  36 #include <svx/svxdllapi.h>
  37 #include <com/sun/star/embed/XStorage.hpp>
  38 #include <basegfx/polygon/b2dpolypolygon.hxx>
  39 #include <com/sun/star/container/XNameContainer.hpp>
  40 #include <svtools/grfmgr.hxx>
  41 #include <svx/XPropertyEntry.hxx>
  42
  43 class Color;
  44 class Bitmap;
  45 class VirtualDevice;
  46
  47 // Standard-Vergleichsstring
  48 extern sal_Unicode pszStandard[]; // "standard"
  49
  50 // Funktion zum Konvertieren in echte RGB-Farben, da mit
  51 // enum COL_NAME nicht verglichen werden kann.
  52 SVX_DLLPUBLIC Color RGB_Color( ColorData nColorName );
  53
  54 // ------------------
  55 // class XColorEntry
  56 // ------------------
  57
  58 class SVX_DLLPUBLIC XColorEntry : public XPropertyEntry
  59 {
  60 private:
  61     Color   aColor;
  62
  63 public:
  64     XColorEntry(const Color& rColor, const OUString& rName);
  65     XColorEntry(const XColorEntry& rOther);
  66
  67     const Color& GetColor() const
  68     {
  69         return aColor;
  70     }
  71 };
  72
  73 // --------------------
  74 // class XLineEndEntry
  75 // --------------------
  76
  77 class SVX_DLLPUBLIC XLineEndEntry : public XPropertyEntry
  78 {
  79 private:
  80     basegfx::B2DPolyPolygon aB2DPolyPolygon;
  81
  82 public:
  83     XLineEndEntry(const basegfx::B2DPolyPolygon& rB2DPolyPolygon, const OUString& rName);
  84     XLineEndEntry(const XLineEndEntry& rOther);
  85
  86     const basegfx::B2DPolyPolygon& GetLineEnd() const
  87     {
  88         return aB2DPolyPolygon;
  89     }
  90 };
  91
  92 // ------------------
  93 // class XDashEntry
  94 // ------------------
  95
  96 class SVX_DLLPUBLIC XDashEntry : public XPropertyEntry
  97 {
  98 private:
  99     XDash   aDash;
 100
 101 public:
 102     XDashEntry(const XDash& rDash, const OUString& rName);
 103     XDashEntry(const XDashEntry& rOther);
 104
 105     const XDash& GetDash() const
 106     {
 107         return aDash;
 108     }
 109 };
 110
 111 // ------------------
 112 // class XHatchEntry
 113 // ------------------
 114
 115 class SVX_DLLPUBLIC XHatchEntry : public XPropertyEntry
 116 {
 117 private:
 118     XHatch  aHatch;
 119
 120 public:
 121     XHatchEntry(const XHatch& rHatch, const OUString& rName);
 122     XHatchEntry(const XHatchEntry& rOther);
 123
 124     const XHatch& GetHatch() const
 125     {
 126         return aHatch;
 127     }
 128 };
 129
 130 // ---------------------
 131 // class XGradientEntry
 132 // ---------------------
 133
 134 class SVX_DLLPUBLIC XGradientEntry : public XPropertyEntry
 135 {
 136 private:
 137     XGradient  aGradient;
 138
 139 public:
 140     XGradientEntry(const XGradient& rGradient, const OUString& rName);
 141     XGradientEntry(const XGradientEntry& rOther);
 142
 143     const XGradient& GetGradient() const
 144     {
 145         return aGradient;
 146     }
 147 };
 148
 149 // ---------------------
 150 // class XBitmapEntry
 151 // ---------------------
 152
 153 class SVX_DLLPUBLIC XBitmapEntry : public XPropertyEntry
 154 {
 155 private:
 156     GraphicObject   maGraphicObject;
 157
 158 public:
 159     XBitmapEntry(const GraphicObject& rGraphicObject, const OUString& rName);
 160     XBitmapEntry(const XBitmapEntry& rOther);
 161
 162     const GraphicObject& GetGraphicObject() const
 163     {
 164         return maGraphicObject;
 165     }
 166 };
 167
 168 // --------------------
 169 // class XPropertyList
 170 // --------------------
 171
 172 enum XPropertyListType {
 173     XCOLOR_LIST,
 174     XLINE_END_LIST,
 175     XDASH_LIST,
 176     XHATCH_LIST,
 177     XGRADIENT_LIST,
 178     XBITMAP_LIST,
 179     XPROPERTY_LIST_COUNT
 180 };
 181
 182 typedef rtl::Reference< class XPropertyList > XPropertyListRef;
 183
 184 class XDashList ; typedef rtl::Reference< class XDashList > XDashListRef;
 185 class XHatchList ; typedef rtl::Reference< class XHatchList > XHatchListRef;
 186 class XColorList ; typedef rtl::Reference< class XColorList > XColorListRef;
 187 class XBitmapList ; typedef rtl::Reference< class XBitmapList > XBitmapListRef;
 188 class XLineEndList ; typedef rtl::Reference< class XLineEndList > XLineEndListRef;
 189 class XGradientList ; typedef rtl::Reference< class XGradientList > XGradientListRef;
 190
 191 class SVX_DLLPUBLIC XPropertyList : public cppu::OWeakObject
 192 {
 193  private:
 194     SAL_DLLPRIVATE void* operator new(size_t);
 195  protected:
 196     SAL_DLLPRIVATE void operator delete(void *);
 197 protected:
 198     typedef ::std::vector< XPropertyEntry* > XPropertyEntryList_impl;
 199     typedef ::std::vector< Bitmap* > BitmapList_impl;
 200
 201     XPropertyListType   meType;
 202     OUString            maName; // not persistent
 203     OUString            maPath;
 204     OUString            maReferer;
 205
 206     XPropertyEntryList_impl maList;
 207
 208     bool                mbListDirty;
 209     bool                mbEmbedInDocument;
 210
 211     XPropertyList(XPropertyListType t, const OUString& rPath, const OUString& rReferer);
 212
 213     virtual Bitmap CreateBitmapForUI(long nIndex) = 0;
 214
 215 public:
 216     virtual ~XPropertyList();
 217
 218     XPropertyListType Type() const { return meType; }
 219     long Count() const;
 220
 221     void Insert(XPropertyEntry* pEntry, long nIndex = CONTAINER_APPEND);
 222     XPropertyEntry* Replace(XPropertyEntry* pEntry, long nIndex);
 223     XPropertyEntry* Remove(long nIndex);
 224
 225     XPropertyEntry* Get(long nIndex) const;
 226     long GetIndex(const OUString& rName) const;
 227     Bitmap GetUiBitmap(long nIndex) const;
 228
 229     const OUString& GetName() const { return maName; }
 230     void SetName(const OUString& rString);
 231
 232     const OUString& GetPath() const { return maPath; }
 233     void SetPath(const OUString& rString) { maPath = rString; }
 234
 235     bool IsDirty() const { return mbListDirty; }
 236     void SetDirty(bool bDirty = true) { mbListDirty = bDirty; }
 237
 238     bool IsEmbedInDocument() const { return mbEmbedInDocument; }
 239     void SetEmbedInDocument(bool b) { mbEmbedInDocument = b; }
 240
 241     static OUString GetDefaultExt(XPropertyListType t);
 242     static OUString GetDefaultExtFilter(XPropertyListType t);
 243     OUString GetDefaultExt() const { return GetDefaultExt(meType); }
 244
 245     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer >
 246         createInstance() = 0;
 247     bool Load();
 248     bool LoadFrom(const ::com::sun::star::uno::Reference<
 249                        ::com::sun::star::embed::XStorage > &xStorage,
 250                   const OUString &rURL, const OUString &rReferer);
 251     bool Save();
 252     bool SaveTo  (const ::com::sun::star::uno::Reference<
 253                        ::com::sun::star::embed::XStorage > &xStorage,
 254                    const OUString &rURL,
 255                                   OUString *pOptName);
 256     virtual bool Create() = 0;
 257
 258     // Factory method for sub-classes
 259     static XPropertyListRef CreatePropertyList(XPropertyListType t,
 260                                                const OUString& rPath,
 261                                                const OUString& rReferer);
 262     // as above but initializes name as expected
 263     static XPropertyListRef CreatePropertyListFromURL(XPropertyListType t,
 264                                                        const OUString & rUrl);
 265
 266     // helper accessors
 267     inline XDashListRef  AsDashList();
 268     inline XHatchListRef AsHatchList();
 269     inline XColorListRef AsColorList();
 270     inline XBitmapListRef AsBitmapList();
 271     inline XLineEndListRef AsLineEndList();
 272     inline XGradientListRef AsGradientList();
 273 };
 274
 275 // ------------------
 276 // class XColorList
 277 // ------------------
 278
 279 class SVX_DLLPUBLIC XColorList : public XPropertyList
 280 {
 281 protected:
 282     virtual Bitmap  CreateBitmapForUI(long nIndex);
 283
 284 public:
 285     XColorList(const OUString& rPath, const OUString& rReferer)
 286         : XPropertyList(XCOLOR_LIST, rPath, rReferer) {}
 287
 288     using XPropertyList::Replace;
 289     using XPropertyList::Remove;
 290
 291     XColorEntry* Replace(long nIndex, XColorEntry* pEntry);
 292     XColorEntry* Remove(long nIndex);
 293     XColorEntry* GetColor(long nIndex) const;
 294     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > createInstance();
 295     virtual bool Create();
 296
 297     static XColorListRef CreateStdColorList();
 298     static XColorListRef GetStdColorList(); // returns a singleton
 299 };
 300
 301 // -------------------
 302 // class XLineEndList
 303 // -------------------
 304
 305 class SVX_DLLPUBLIC XLineEndList : public XPropertyList
 306 {
 307 protected:
 308     virtual Bitmap CreateBitmapForUI(long nIndex);
 309
 310 public:
 311     XLineEndList(const OUString& rPath, const OUString& rReferer);
 312     virtual ~XLineEndList();
 313
 314     using XPropertyList::Remove;
 315     XLineEndEntry* Remove(long nIndex);
 316     XLineEndEntry* GetLineEnd(long nIndex) const;
 317
 318     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > createInstance();
 319     virtual bool Create();
 320 };
 321
 322 // -------------------
 323 // class XDashList
 324 // -------------------
 325
 326 class SVX_DLLPUBLIC XDashList : public XPropertyList
 327 {
 328 private:
 329     Bitmap              maBitmapSolidLine;
 330     OUString            maStringSolidLine;
 331     OUString            maStringNoLine;
 332
 333 protected:
 334     Bitmap ImpCreateBitmapForXDash(const XDash* pDash);
 335     virtual Bitmap CreateBitmapForUI(long nIndex);
 336
 337 public:
 338     XDashList(const OUString& rPath, const OUString& rReferer);
 339     virtual ~XDashList();
 340
 341     using XPropertyList::Replace;
 342     XDashEntry* Replace(XDashEntry* pEntry, long nIndex);
 343     using XPropertyList::Remove;
 344     XDashEntry* Remove(long nIndex);
 345     XDashEntry* GetDash(long nIndex) const;
 346
 347     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > createInstance();
 348     virtual bool Create();
 349
 350     // Special call to get a bitmap for the solid line representation. It
 351     // creates a bitmap fitting in size and style to the ones you get by
 352     // using GetUiBitmap for existing entries.
 353     Bitmap GetBitmapForUISolidLine() const;
 354
 355     // Special calls to get the translated strings for the UI entry for no
 356     // line style (XLINE_NONE) and solid line style (XLINE_SOLID) for dialogs
 357     OUString GetStringForUiSolidLine() const;
 358     OUString GetStringForUiNoLine() const;
 359 };
 360
 361 // -------------------
 362 // class XHatchList
 363 // -------------------
 364
 365 class SVX_DLLPUBLIC XHatchList : public XPropertyList
 366 {
 367 protected:
 368     virtual Bitmap CreateBitmapForUI(long nIndex);
 369
 370 public:
 371     XHatchList(const OUString& rPath, const OUString& rReferer);
 372     virtual ~XHatchList();
 373
 374     using XPropertyList::Replace;
 375     XHatchEntry* Replace(XHatchEntry* pEntry, long nIndex);
 376     using XPropertyList::Remove;
 377     XHatchEntry* Remove(long nIndex);
 378     XHatchEntry* GetHatch(long nIndex) const;
 379
 380     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > createInstance();
 381     virtual bool Create();
 382 };
 383
 384 // -------------------
 385 // class XGradientList
 386 // -------------------
 387 class SVX_DLLPUBLIC XGradientList : public XPropertyList
 388 {
 389 protected:
 390     virtual Bitmap CreateBitmapForUI(long nIndex);
 391
 392 public:
 393     XGradientList(const OUString& rPath, const OUString& rReferer);
 394     virtual ~XGradientList();
 395
 396     using XPropertyList::Replace;
 397     XGradientEntry* Replace(XGradientEntry* pEntry, long nIndex);
 398     using XPropertyList::Remove;
 399     XGradientEntry* Remove(long nIndex);
 400     XGradientEntry* GetGradient(long nIndex) const;
 401
 402     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > createInstance();
 403     virtual bool Create();
 404 };
 405
 406 // -------------------
 407 // class XBitmapList
 408 // -------------------
 409
 410 class SVX_DLLPUBLIC XBitmapList : public XPropertyList
 411 {
 412 protected:
 413     virtual Bitmap CreateBitmapForUI(long nIndex);
 414
 415 public:
 416     XBitmapList(const OUString& rPath, const OUString& rReferer)
 417         : XPropertyList(XBITMAP_LIST, rPath, rReferer) {}
 418
 419     using XPropertyList::Replace;
 420     using XPropertyList::Remove;
 421     XBitmapEntry* Remove(long nIndex);
 422     XBitmapEntry* GetBitmap(long nIndex) const;
 423
 424     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > createInstance();
 425     virtual bool Create();
 426 };
 427
 428
 429 // FIXME: could add type checking too ...
 430 inline XDashListRef  XPropertyList::AsDashList() { return XDashListRef( static_cast<XDashList *> (this) ); }
 431 inline XHatchListRef XPropertyList::AsHatchList() { return XHatchListRef( static_cast<XHatchList *> (this) ); }
 432 inline XColorListRef XPropertyList::AsColorList() { return XColorListRef( static_cast<XColorList *> (this) ); }
 433 inline XBitmapListRef XPropertyList::AsBitmapList() { return XBitmapListRef( static_cast<XBitmapList *> (this) ); }
 434 inline XLineEndListRef XPropertyList::AsLineEndList() { return XLineEndListRef( static_cast<XLineEndList *> (this) ); }
 435 inline XGradientListRef XPropertyList::AsGradientList() { return XGradientListRef( static_cast<XGradientList *> (this) ); }
 436
 437 #endif // INCLUDED_SVX_XTABLE_HXX
 438
 439 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */