LibreOffice Module svl (master) 1
Classes | Macros | Typedefs | Enumerations | Functions
poolitem.hxx File Reference
#include <sal/config.h>
#include <memory>
#include <vector>
#include <com/sun/star/uno/Any.hxx>
#include <svl/hint.hxx>
#include <svl/svldllapi.h>
#include <svl/typedwhich.hxx>
#include <tools/mapunit.hxx>
#include <tools/long.hxx>
#include <boost/property_tree/ptree_fwd.hpp>
Include dependency graph for poolitem.hxx:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  SfxPoolItem
 
class  SfxVoidItem
 
class  SfxPoolItemHint
 

Macros

#define SFX_ITEMS_OLD_MAXREF   0xffef
 
#define SFX_ITEMS_MAXREF   0xfffffffe
 
#define SFX_ITEMS_SPECIAL   0xffffffff
 
#define CONVERT_TWIPS   0x80
 
#define INVALID_POOL_ITEM   reinterpret_cast<SfxPoolItem*>(-1)
 

Typedefs

typedef struct _xmlTextWriter * xmlTextWriterPtr
 

Enumerations

enum class  SfxItemKind : sal_Int8 {
  NONE ,
  DeleteOnIdle ,
  StaticDefault ,
  PoolDefault
}
 
enum class  SfxItemPresentation {
  Nameless ,
  Complete
}
 
enum class  SfxItemState {
  UNKNOWN = 0 ,
  DISABLED = 0x0001 ,
  DONTCARE = 0x0010 ,
  DEFAULT = 0x0020 ,
  SET = 0x0040
}
 These values have to match the values in the css::frame::status::ItemState IDL to be found at offapi/com/sun/star/frame/status/ItemState.idl. More...
 

Functions

bool Any2Bool (const css::uno::Any &rValue)
 
bool IsPoolDefaultItem (const SfxPoolItem *pItem)
 
bool IsStaticDefaultItem (const SfxPoolItem *pItem)
 
bool IsDefaultItem (const SfxPoolItem *pItem)
 
bool IsPooledItem (const SfxPoolItem *pItem)
 
bool IsInvalidItem (const SfxPoolItem *pItem)
 

Macro Definition Documentation

◆ CONVERT_TWIPS

#define CONVERT_TWIPS   0x80

Definition at line 50 of file poolitem.hxx.

◆ INVALID_POOL_ITEM

#define INVALID_POOL_ITEM   reinterpret_cast<SfxPoolItem*>(-1)

Definition at line 109 of file poolitem.hxx.

◆ SFX_ITEMS_MAXREF

#define SFX_ITEMS_MAXREF   0xfffffffe

Definition at line 47 of file poolitem.hxx.

◆ SFX_ITEMS_OLD_MAXREF

#define SFX_ITEMS_OLD_MAXREF   0xffef

Definition at line 46 of file poolitem.hxx.

◆ SFX_ITEMS_SPECIAL

#define SFX_ITEMS_SPECIAL   0xffffffff

Definition at line 48 of file poolitem.hxx.

Typedef Documentation

◆ xmlTextWriterPtr

typedef struct _xmlTextWriter* xmlTextWriterPtr

Definition at line 113 of file poolitem.hxx.

Enumeration Type Documentation

◆ SfxItemKind

enum class SfxItemKind : sal_Int8
strong
Enumerator
NONE 
DeleteOnIdle 
StaticDefault 
PoolDefault 

Definition at line 38 of file poolitem.hxx.

◆ SfxItemPresentation

enum class SfxItemPresentation
strong
Enumerator
Nameless 
Complete 

Definition at line 71 of file poolitem.hxx.

◆ SfxItemState

enum class SfxItemState
strong

These values have to match the values in the css::frame::status::ItemState IDL to be found at offapi/com/sun/star/frame/status/ItemState.idl.

Enumerator
UNKNOWN 

Specifies an unknown state.

DISABLED 

Specifies that the property is currently disabled.

DONTCARE 

Specifies that the property is currently in a don't care state.


This is normally used if a selection provides more than one state for a property at the same time.

DEFAULT 

Specifies that the property is currently in a default state.

SET 

The property has been explicitly set to a given value hence we know we are not taking the default value.


For example, you may want to get the font color and it might either be the default one or one that has been explicitly set.

Definition at line 82 of file poolitem.hxx.

Function Documentation

◆ Any2Bool()

bool Any2Bool ( const css::uno::Any rValue)
inline

Definition at line 53 of file poolitem.hxx.

◆ IsDefaultItem()

bool IsDefaultItem ( const SfxPoolItem pItem)
inline

◆ IsInvalidItem()

bool IsInvalidItem ( const SfxPoolItem pItem)
inline

◆ IsPoolDefaultItem()

bool IsPoolDefaultItem ( const SfxPoolItem pItem)
inline

◆ IsPooledItem()

bool IsPooledItem ( const SfxPoolItem pItem)
inline

Definition at line 284 of file poolitem.hxx.

References SfxPoolItem::GetRefCount(), and SFX_ITEMS_MAXREF.

Referenced by SfxItemPoolCache::ApplyTo(), and SfxItemPool::PutImpl().

◆ IsStaticDefaultItem()

bool IsStaticDefaultItem ( const SfxPoolItem pItem)
inline