SvtViewOptions Class Reference

#include <viewoptions.hxx>

Public Member Functions
	SvtViewOptions (EViewType eType, OUString sViewName)
bool	Exists () const
void	Delete ()
OUString	GetWindowState () const
void	SetWindowState (const OUString &sState)
OUString	GetPageID () const
void	SetPageID (const OUString &rID)
bool	IsVisible () const
void	SetVisible (bool bState)
bool	HasVisible () const
	Return true if the "Visible" property actually has a non-nil value. More...
css::uno::Sequence< css::beans::NamedValue >	GetUserData () const
void	SetUserData (const css::uno::Sequence< css::beans::NamedValue > &lData)
css::uno::Any	GetUserItem (const OUString &sName) const
void	SetUserItem (const OUString &sName, const css::uno::Any &aValue)

Private Types
enum	State {   STATE_NONE ,   STATE_FALSE ,   STATE_TRUE }

Private Member Functions
css::uno::Reference< css::uno::XInterface >	impl_getSetNode (const OUString &sNode, bool bCreateIfMissing) const
State	GetVisible () const

Private Attributes
EViewType	m_eViewType
	specify which list of views in configuration is used! This can't be a static value!!! ... because we need this value to work with right static data container. More...
OUString	m_sViewName
OUString	m_sListName
css::uno::Reference< css::container::XNameAccess >	m_xRoot
css::uno::Reference< css::container::XNameAccess >	m_xSet

Detailed Description

Definition at line 94 of file viewoptions.hxx.

Member Enumeration Documentation

State

enum SvtViewOptions::State

private

Enumerator
STATE_NONE
STATE_FALSE
STATE_TRUE

Definition at line 205 of file viewoptions.hxx.

Constructor & Destructor Documentation

SvtViewOptions()

SvtViewOptions::SvtViewOptions	(	EViewType	eType,
		OUString	sViewName
	)

Definition at line 40 of file viewoptions.cxx.

References Dialog, eType, utl::ConfigManager::IsFuzzing(), m_eViewType, m_sListName, m_xRoot, m_xSet, comphelper::ConfigurationHelper::openConfig(), PACKAGE_VIEWS, comphelper::Standard, TabDialog, TabPage, TOOLS_WARN_EXCEPTION, and Window.

Member Function Documentation

Delete()

void SvtViewOptions::Delete

(

)

Definition at line 115 of file viewoptions.cxx.

References comphelper::ConfigurationHelper::flush(), m_sViewName, m_xRoot, m_xSet, and TOOLS_WARN_EXCEPTION.

Exists()

bool SvtViewOptions::Exists

(

)

const

Definition at line 87 of file viewoptions.cxx.

References m_sViewName, m_xSet, and TOOLS_WARN_EXCEPTION.

GetPageID()

OUString SvtViewOptions::GetPageID

(

)

const

Definition at line 190 of file viewoptions.cxx.

References impl_getSetNode(), m_eViewType, m_sViewName, PROPERTY_PAGEID, TabDialog, and TOOLS_WARN_EXCEPTION.

GetUserData()

css::uno::Sequence< css::beans::NamedValue > SvtViewOptions::GetUserData

(

)

const

Definition at line 305 of file viewoptions.cxx.

References impl_getSetNode(), m_sViewName, and PROPERTY_USERDATA.

GetUserItem()

css::uno::Any SvtViewOptions::GetUserItem

(

const OUString &

sName

)

const

Definition at line 363 of file viewoptions.cxx.

References impl_getSetNode(), m_sViewName, PROPERTY_USERDATA, and TOOLS_WARN_EXCEPTION.

GetVisible()

SvtViewOptions::State SvtViewOptions::GetVisible ( ) const

private

Definition at line 248 of file viewoptions.cxx.

References bVisible, impl_getSetNode(), m_sViewName, PROPERTY_VISIBLE, STATE_FALSE, STATE_NONE, STATE_TRUE, and TOOLS_WARN_EXCEPTION.

Referenced by HasVisible(), and IsVisible().

GetWindowState()

OUString SvtViewOptions::GetWindowState

(

)

const

Definition at line 139 of file viewoptions.cxx.

References impl_getSetNode(), m_sViewName, PROPERTY_WINDOWSTATE, and TOOLS_WARN_EXCEPTION.

HasVisible()

bool SvtViewOptions::HasVisible

(

)

const

Return true if the "Visible" property actually has a non-nil value.

(IsVisible will somewhat arbitrarily return false if the property is nil.)

Definition at line 296 of file viewoptions.cxx.

References GetVisible(), m_eViewType, STATE_NONE, and Window.

impl_getSetNode()

css::uno::Reference< css::uno::XInterface > SvtViewOptions::impl_getSetNode ( const OUString &  sNode, bool  bCreateIfMissing  ) const

private

Definition at line 424 of file viewoptions.cxx.

References m_sListName, m_xRoot, m_xSet, comphelper::ConfigurationHelper::makeSureSetNodeExists(), and TOOLS_WARN_EXCEPTION.

Referenced by GetPageID(), GetUserData(), GetUserItem(), GetVisible(), GetWindowState(), SetPageID(), SetUserData(), SetUserItem(), SetVisible(), and SetWindowState().

IsVisible()

bool SvtViewOptions::IsVisible

(

)

const

Definition at line 239 of file viewoptions.cxx.

References GetVisible(), m_eViewType, STATE_TRUE, and Window.

SetPageID()

void SvtViewOptions::SetPageID

(

const OUString &

rID

)

Definition at line 216 of file viewoptions.cxx.

References comphelper::ConfigurationHelper::flush(), impl_getSetNode(), m_eViewType, m_sViewName, m_xRoot, PROPERTY_PAGEID, TabDialog, and TOOLS_WARN_EXCEPTION.

SetUserData()

void SvtViewOptions::SetUserData

(

const css::uno::Sequence< css::beans::NamedValue > &

lData

)

Definition at line 336 of file viewoptions.cxx.

References comphelper::ConfigurationHelper::flush(), impl_getSetNode(), m_sViewName, m_xRoot, PROPERTY_USERDATA, and TOOLS_WARN_EXCEPTION.

SetUserItem()

void SvtViewOptions::SetUserItem	(	const OUString &	sName,
		const css::uno::Any &	aValue
	)

Definition at line 388 of file viewoptions.cxx.

References comphelper::ConfigurationHelper::flush(), impl_getSetNode(), m_sViewName, m_xRoot, PROPERTY_USERDATA, and TOOLS_WARN_EXCEPTION.

SetVisible()

void SvtViewOptions::SetVisible

(

bool

bState

)

Definition at line 274 of file viewoptions.cxx.

References bVisible, comphelper::ConfigurationHelper::flush(), impl_getSetNode(), m_eViewType, m_sViewName, m_xRoot, PROPERTY_VISIBLE, TOOLS_WARN_EXCEPTION, and Window.

SetWindowState()

void SvtViewOptions::SetWindowState

(

const OUString &

sState

)

Definition at line 172 of file viewoptions.cxx.

References comphelper::ConfigurationHelper::flush(), impl_getSetNode(), m_sViewName, m_xRoot, PROPERTY_WINDOWSTATE, and TOOLS_WARN_EXCEPTION.

Member Data Documentation

m_eViewType

EViewType SvtViewOptions::m_eViewType

private

specify which list of views in configuration is used! This can't be a static value!!! ... because we need this value to work with right static data container.

Definition at line 213 of file viewoptions.hxx.

Referenced by GetPageID(), HasVisible(), IsVisible(), SetPageID(), SetVisible(), and SvtViewOptions().

m_sListName

OUString SvtViewOptions::m_sListName

private

Definition at line 216 of file viewoptions.hxx.

Referenced by impl_getSetNode(), and SvtViewOptions().

m_sViewName

OUString SvtViewOptions::m_sViewName

private

Definition at line 214 of file viewoptions.hxx.

Referenced by Delete(), Exists(), GetPageID(), GetUserData(), GetUserItem(), GetVisible(), GetWindowState(), SetPageID(), SetUserData(), SetUserItem(), SetVisible(), and SetWindowState().

m_xRoot

css::uno::Reference< css::container::XNameAccess > SvtViewOptions::m_xRoot

private

Definition at line 217 of file viewoptions.hxx.

Referenced by Delete(), impl_getSetNode(), SetPageID(), SetUserData(), SetUserItem(), SetVisible(), SetWindowState(), and SvtViewOptions().

m_xSet

css::uno::Reference< css::container::XNameAccess > SvtViewOptions::m_xSet

private

Definition at line 218 of file viewoptions.hxx.

Referenced by Delete(), Exists(), impl_getSetNode(), and SvtViewOptions().

---

The documentation for this class was generated from the following files:

• viewoptions.hxx
• viewoptions.cxx