373 lines
13 KiB
C++
373 lines
13 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_SVL_STYLE_HXX
|
|
#define INCLUDED_SVL_STYLE_HXX
|
|
|
|
#include <com/sun/star/style/XStyle.hpp>
|
|
#include <com/sun/star/lang/XUnoTunnel.hpp>
|
|
|
|
#include <rtl/ref.hxx>
|
|
#include <comphelper/weak.hxx>
|
|
#include <cppuhelper/implbase2.hxx>
|
|
#include <svl/svldllapi.h>
|
|
#include <rsc/rscsfx.hxx>
|
|
#include <svl/hint.hxx>
|
|
#include <svl/lstner.hxx>
|
|
#include <svl/poolitem.hxx>
|
|
#include <svl/SfxBroadcaster.hxx>
|
|
#include <svl/stylesheetuser.hxx>
|
|
|
|
#include <svl/style.hrc>
|
|
#include <memory>
|
|
|
|
class SfxItemSet;
|
|
class SfxItemPool;
|
|
class SfxStyleSheetBasePool;
|
|
class SvStream;
|
|
|
|
namespace svl { class IndexedStyleSheets; }
|
|
/*
|
|
Everyone changing instances of SfxStyleSheetBasePool or SfxStyleSheetBase
|
|
must broadcast this using <SfxStyleSheetBasePool::GetBroadcaster()> broadcasts.
|
|
The class <SfxStyleSheetHint> is used for this, it contains an Action-Id and a
|
|
pointer to the <SfxStyleSheetBase>. The actions are:
|
|
|
|
#define SfxStyleSheetHintId::CREATED // style is created
|
|
#define SfxStyleSheetHintId::MODIFIED // style is modified
|
|
#define SfxStyleSheetHintId::CHANGED // style is replaced
|
|
#define SfxStyleSheetHintId::ERASED // style is deleted
|
|
|
|
The following methods already broadcast themself
|
|
|
|
SfxSimpleHint(SFX_HINT_DYING) from:
|
|
SfxStyleSheetBasePool::~SfxStyleSheetBasePool()
|
|
|
|
SfxStyleSheetHint( SfxStyleSheetHintId::CREATED, *p ) from:
|
|
SfxStyleSheetBasePool::Make( const String& rName,
|
|
SfxStyleFamily eFam, sal_uInt16 mask)
|
|
|
|
SfxStyleSheetHint( SfxStyleSheetHintId::CHANGED, *pNew ) from:
|
|
SfxStyleSheetBasePool::Add( SfxStyleSheetBase& rSheet )
|
|
|
|
SfxStyleSheetHint( SfxStyleSheetHintId::ERASED, *p ) from:
|
|
SfxStyleSheetBasePool::Erase( SfxStyleSheetBase* p )
|
|
SfxStyleSheetBasePool::Clear()
|
|
*/
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheetBase : public comphelper::OWeakTypeObject
|
|
{
|
|
private:
|
|
friend class SfxStyleSheetBasePool;
|
|
SVL_DLLPRIVATE static SfxStyleSheetBasePool& implGetStaticPool();
|
|
|
|
protected:
|
|
SfxStyleSheetBasePool* pPool; // related pool
|
|
SfxStyleFamily nFamily;
|
|
|
|
OUString aName, aParent, aFollow;
|
|
OUString maDisplayName;
|
|
OUString aHelpFile; // name of the help file
|
|
SfxItemSet* pSet; // ItemSet
|
|
sal_uInt16 nMask; // Flags
|
|
|
|
sal_uLong nHelpId; // help ID
|
|
|
|
bool bMySet; // sal_True: delete Set in dtor
|
|
bool bHidden;
|
|
|
|
SfxStyleSheetBase( const OUString&, SfxStyleSheetBasePool*, SfxStyleFamily eFam, sal_uInt16 mask );
|
|
SfxStyleSheetBase( const SfxStyleSheetBase& );
|
|
virtual ~SfxStyleSheetBase();
|
|
virtual void Load( SvStream&, sal_uInt16 );
|
|
virtual void Store( SvStream& );
|
|
|
|
public:
|
|
TYPEINFO();
|
|
|
|
// returns the internal name of this style
|
|
virtual const OUString& GetName() const;
|
|
|
|
// sets the internal name of this style.
|
|
//
|
|
// If the name of a style is changed, then the styles container needs to be
|
|
// reindexed (see IndexedStyleSheets). If you set bReindexNow to false to
|
|
// defer that indexing, then you must call the Reindex manually on the
|
|
// SfxStyleSheetBasePool parent.
|
|
virtual bool SetName(const OUString& rNewName, bool bReindexNow = true);
|
|
|
|
/** returns the display name of this style, it is used at the user interface.
|
|
If the display name is empty, this method returns the internal name. */
|
|
OUString GetDisplayName() const;
|
|
|
|
virtual const OUString& GetParent() const;
|
|
virtual bool SetParent( const OUString& );
|
|
virtual const OUString& GetFollow() const;
|
|
virtual bool SetFollow( const OUString& );
|
|
virtual bool HasFollowSupport() const; // Default true
|
|
virtual bool HasParentSupport() const; // Default true
|
|
virtual bool HasClearParentSupport() const; // Default false
|
|
virtual bool IsUsed() const; // Default true
|
|
// Default from the Itemset; either from the passed one
|
|
// or from the Set returned by GetItemSet()
|
|
virtual OUString GetDescription();
|
|
virtual OUString GetDescription( SfxMapUnit eMetric );
|
|
|
|
SfxStyleSheetBasePool& GetPool() { return *pPool; }
|
|
SfxStyleFamily GetFamily() const { return nFamily; }
|
|
sal_uInt16 GetMask() const { return nMask; }
|
|
void SetMask( sal_uInt16 mask) { nMask = mask; }
|
|
bool IsUserDefined() const
|
|
{ return ( nMask & SFXSTYLEBIT_USERDEF) != 0; }
|
|
|
|
virtual bool IsHidden() const { return bHidden; }
|
|
virtual void SetHidden( bool bValue );
|
|
|
|
virtual sal_uLong GetHelpId( OUString& rFile );
|
|
virtual void SetHelpId( const OUString& r, sal_uLong nId );
|
|
|
|
virtual SfxItemSet& GetItemSet();
|
|
};
|
|
|
|
/* Class to iterate and search on a SfxStyleSheetBasePool */
|
|
class SVL_DLLPUBLIC SfxStyleSheetIterator
|
|
{
|
|
public:
|
|
/** Constructor.
|
|
* The iterator will only iterate over style sheets which have the family \p eFam
|
|
*/
|
|
SfxStyleSheetIterator(SfxStyleSheetBasePool *pBase,
|
|
SfxStyleFamily eFam, sal_uInt16 n=SFXSTYLEBIT_ALL );
|
|
sal_uInt16 GetSearchMask() const;
|
|
SfxStyleFamily GetSearchFamily() const;
|
|
virtual sal_uInt16 Count();
|
|
virtual SfxStyleSheetBase *operator[](sal_uInt16 nIdx);
|
|
virtual SfxStyleSheetBase* First();
|
|
virtual SfxStyleSheetBase* Next();
|
|
virtual SfxStyleSheetBase* Find(const OUString& rStr);
|
|
virtual ~SfxStyleSheetIterator();
|
|
|
|
bool SearchUsed() const { return bSearchUsed; }
|
|
|
|
protected:
|
|
|
|
SfxStyleSheetBasePool* pBasePool;
|
|
SfxStyleFamily nSearchFamily;
|
|
sal_uInt16 nMask;
|
|
|
|
|
|
private:
|
|
sal_uInt16 GetPos() { return nAktPosition; }
|
|
SVL_DLLPRIVATE bool IsTrivialSearch();
|
|
|
|
SfxStyleSheetBase* pAktStyle;
|
|
sal_uInt16 nAktPosition;
|
|
bool bSearchUsed;
|
|
|
|
friend class SfxStyleSheetBasePool;
|
|
};
|
|
|
|
typedef std::shared_ptr< SfxStyleSheetIterator > SfxStyleSheetIteratorPtr;
|
|
|
|
|
|
class SfxStyleSheetBasePool_Impl;
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheetBasePool: public SfxBroadcaster, public comphelper::OWeakTypeObject
|
|
{
|
|
friend class SfxStyleSheetIterator;
|
|
friend class SfxStyleSheetBase;
|
|
|
|
SfxStyleSheetBasePool_Impl *pImp;
|
|
|
|
protected:
|
|
SfxStyleSheetIterator& GetIterator_Impl();
|
|
|
|
OUString aAppName;
|
|
SfxItemPool& rPool;
|
|
SfxStyleFamily nSearchFamily;
|
|
sal_uInt16 nMask;
|
|
|
|
void ChangeParent( const OUString&, const OUString&, bool bVirtual = true );
|
|
virtual SfxStyleSheetBase* Create( const OUString&, SfxStyleFamily, sal_uInt16 );
|
|
virtual SfxStyleSheetBase* Create( const SfxStyleSheetBase& );
|
|
|
|
virtual ~SfxStyleSheetBasePool();
|
|
|
|
void StoreStyleSheet(rtl::Reference< SfxStyleSheetBase >);
|
|
|
|
/** Obtain the indexed style sheets.
|
|
*/
|
|
const svl::IndexedStyleSheets&
|
|
GetIndexedStyleSheets() const;
|
|
rtl::Reference<SfxStyleSheetBase>
|
|
GetStyleSheetByPositionInIndex(unsigned pos);
|
|
|
|
public:
|
|
SfxStyleSheetBasePool( SfxItemPool& );
|
|
SfxStyleSheetBasePool( const SfxStyleSheetBasePool& );
|
|
|
|
const OUString& GetAppName() const { return aAppName; }
|
|
|
|
SfxItemPool& GetPool() { return rPool;}
|
|
const SfxItemPool& GetPool() const { return rPool;}
|
|
|
|
virtual SfxStyleSheetIteratorPtr CreateIterator(SfxStyleFamily, sal_uInt16 nMask);
|
|
sal_uInt16 Count();
|
|
SfxStyleSheetBase* operator[](sal_uInt16 nIdx);
|
|
|
|
virtual SfxStyleSheetBase& Make(const OUString&,
|
|
SfxStyleFamily eFam,
|
|
sal_uInt16 nMask = SFXSTYLEBIT_ALL);
|
|
|
|
virtual void Replace(
|
|
SfxStyleSheetBase& rSource, SfxStyleSheetBase& rTarget );
|
|
|
|
virtual void Remove( SfxStyleSheetBase* );
|
|
void Insert( SfxStyleSheetBase* );
|
|
|
|
void Clear();
|
|
|
|
SfxStyleSheetBasePool& operator=( const SfxStyleSheetBasePool& );
|
|
SfxStyleSheetBasePool& operator+=( const SfxStyleSheetBasePool& );
|
|
|
|
unsigned GetNumberOfStyles();
|
|
|
|
SfxStyleSheetBase* First();
|
|
SfxStyleSheetBase* Next();
|
|
virtual SfxStyleSheetBase* Find( const OUString&, SfxStyleFamily eFam, sal_uInt16 n=SFXSTYLEBIT_ALL );
|
|
|
|
virtual bool SetParent(SfxStyleFamily eFam,
|
|
const OUString &rStyle,
|
|
const OUString &rParent);
|
|
|
|
SfxStyleSheetBase* Find(const OUString& rStr)
|
|
{ return Find(rStr, nSearchFamily, nMask); }
|
|
|
|
void SetSearchMask(SfxStyleFamily eFam, sal_uInt16 n=SFXSTYLEBIT_ALL );
|
|
sal_uInt16 GetSearchMask() const { return nMask;}
|
|
SfxStyleFamily GetSearchFamily() const { return nSearchFamily; }
|
|
|
|
void Reindex();
|
|
/** Add a style sheet.
|
|
* Not an actual public function. Do not call it from non-subclasses.
|
|
*/
|
|
SfxStyleSheetBase& Add( const SfxStyleSheetBase& );
|
|
};
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheet: public SfxStyleSheetBase,
|
|
public SfxListener, public SfxBroadcaster, public svl::StyleSheetUser
|
|
{
|
|
public:
|
|
TYPEINFO_OVERRIDE();
|
|
|
|
SfxStyleSheet( const OUString&, const SfxStyleSheetBasePool&, SfxStyleFamily, sal_uInt16 );
|
|
SfxStyleSheet( const SfxStyleSheet& );
|
|
|
|
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
|
|
|
|
virtual bool isUsedByModel() const SAL_OVERRIDE;
|
|
|
|
virtual bool SetParent( const OUString& ) SAL_OVERRIDE;
|
|
|
|
protected:
|
|
SfxStyleSheet() // do not use! needed by MSVC at compile time to satisfy ImplInheritanceHelper2
|
|
: SfxStyleSheetBase(OUString("dummy"), NULL, SFX_STYLE_FAMILY_ALL, 0)
|
|
{
|
|
assert(false);
|
|
}
|
|
virtual ~SfxStyleSheet();
|
|
|
|
};
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheetPool: public SfxStyleSheetBasePool
|
|
{
|
|
protected:
|
|
using SfxStyleSheetBasePool::Create;
|
|
virtual SfxStyleSheetBase* Create(const OUString&, SfxStyleFamily, sal_uInt16 mask) SAL_OVERRIDE;
|
|
|
|
public:
|
|
SfxStyleSheetPool( SfxItemPool const& );
|
|
};
|
|
|
|
|
|
|
|
enum SfxStyleSheetHintId
|
|
{
|
|
CREATED = 1, // new
|
|
MODIFIED = 2, // changed
|
|
CHANGED = 3, // erased and re-created (replaced)
|
|
ERASED = 4, // erased
|
|
INDESTRUCTION = 5, // in the process of being destructed
|
|
};
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheetPoolHint : public SfxHint
|
|
{
|
|
SfxStyleSheetHintId nHint;
|
|
|
|
public:
|
|
SfxStyleSheetPoolHint(SfxStyleSheetHintId nArgHint) : nHint(nArgHint){}
|
|
SfxStyleSheetHintId GetHint() const
|
|
{ return nHint; }
|
|
};
|
|
|
|
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheetHint: public SfxHint
|
|
{
|
|
SfxStyleSheetBase* pStyleSh;
|
|
sal_uInt16 nHint;
|
|
|
|
public:
|
|
SfxStyleSheetHint( sal_uInt16, SfxStyleSheetBase& );
|
|
SfxStyleSheetBase* GetStyleSheet() const
|
|
{ return pStyleSh; }
|
|
sal_uInt16 GetHint() const
|
|
{ return nHint; }
|
|
};
|
|
|
|
class SVL_DLLPUBLIC SfxStyleSheetHintExtended: public SfxStyleSheetHint
|
|
{
|
|
OUString aName;
|
|
|
|
public:
|
|
SfxStyleSheetHintExtended( sal_uInt16, const OUString& rOld,
|
|
SfxStyleSheetBase& );
|
|
const OUString& GetOldName() const { return aName; }
|
|
};
|
|
|
|
class SVL_DLLPUBLIC SfxUnoStyleSheet : public ::cppu::ImplInheritanceHelper2< SfxStyleSheet, ::com::sun::star::style::XStyle, ::com::sun::star::lang::XUnoTunnel >
|
|
{
|
|
public:
|
|
SfxUnoStyleSheet( const OUString& _rName, const SfxStyleSheetBasePool& _rPool, SfxStyleFamily _eFamily, sal_uInt16 _nMaske );
|
|
|
|
static SfxUnoStyleSheet* getUnoStyleSheet( const ::com::sun::star::uno::Reference< ::com::sun::star::style::XStyle >& xStyle );
|
|
|
|
// XUnoTunnel
|
|
virtual ::sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< ::sal_Int8 >& aIdentifier ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
private:
|
|
SfxUnoStyleSheet(); // not implemented
|
|
|
|
static const ::com::sun::star::uno::Sequence< ::sal_Int8 >& getIdentifier();
|
|
};
|
|
|
|
#endif
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|