LibreOffice Module sw (master) 1
Public Member Functions | Private Attributes | List of all members
SwContentControl Class Referencefinal

Stores the properties of a content control. More...

#include <formatcontentcontrol.hxx>

Inheritance diagram for SwContentControl:
[legend]
Collaboration diagram for SwContentControl:
[legend]

Public Member Functions

SwTextContentControl * GetTextAttr () const
 
SwTextNode * GetTextNode () const
 
SwFormatContentControl * GetFormatContentControl () const
 
void SetFormatContentControl (SwFormatContentControl *pFormat)
 
void NotifyChangeTextNode (SwTextNode *pTextNode)
 
const unotools::WeakReference< SwXContentControl > & GetXContentControl () const
 
void SetXContentControl (const rtl::Reference< SwXContentControl > &xContentControl)
 
virtual void SwClientNotify (const SwModify &, const SfxHint &) override
 
 SwContentControl (SwFormatContentControl *pFormat)
 
virtual ~SwContentControl () override
 
void SetShowingPlaceHolder (bool bShowingPlaceHolder)
 
bool GetShowingPlaceHolder () const
 
void SetCheckbox (bool bCheckbox)
 
bool GetCheckbox () const
 
void SetChecked (bool bChecked)
 
bool GetChecked () const
 
void SetCheckedState (const OUString &rCheckedState)
 
const OUString & GetCheckedState () const
 
void SetUncheckedState (const OUString &rUncheckedState)
 
const OUString & GetUncheckedState () const
 
const std::vector< SwContentControlListItem > & GetListItems () const
 
void SetListItems (const std::vector< SwContentControlListItem > &rListItems)
 
bool AddListItem (size_t nZIndex, const OUString &rDisplayText, const OUString &rValue)
 
void DeleteListItem (size_t nZIndex)
 
void ClearListItems ()
 
void SetPicture (bool bPicture)
 
bool GetPicture () const
 
void SetDate (bool bDate)
 
bool GetDate () const
 
void SetDateFormat (const OUString &rDateFormat)
 
const OUString & GetDateFormat () const
 
void SetDateLanguage (const OUString &rDateLanguage)
 
const OUString & GetDateLanguage () const
 
void SetCurrentDate (const OUString &rCurrentDate)
 
const OUString & GetCurrentDate () const
 
void SetCurrentDateValue (double fCurrentDate)
 Formats fCurrentDate and sets it. More...
 
double GetCurrentDateValue () const
 Parses m_aCurrentDate and returns it. More...
 
OUString GetDateString () const
 Formats m_oSelectedDate, taking m_aDateFormat and m_aDateLanguage into account. More...
 
void SetPlainText (bool bPlainText)
 
bool GetPlainText () const
 
void SetComboBox (bool bComboBox)
 
bool GetComboBox () const
 
void SetDropDown (bool bDropDown)
 
bool GetDropDown () const
 
void SetPlaceholderDocPart (const OUString &rPlaceholderDocPart)
 
const OUString & GetPlaceholderDocPart () const
 
void SetSelectedListItem (std::optional< size_t > oSelectedListItem)
 
const std::optional< size_t > & GetSelectedListItem () const
 
std::optional< size_t > GetSelectedListItem (bool bCheckDocModel) const
 Get a copy of selected list item's index, potentially even if the selection is already written out to text (i.e. More...
 
void SetSelectedDate (std::optional< double > oSelectedDate)
 
const std::optional< double > & GetSelectedDate () const
 
bool IsInteractingCharacter (sal_Unicode cCh)
 Should this character (during key input) interact with the content control? More...
 
bool ShouldOpenPopup (const vcl::KeyCode &rKeyCode)
 Given rKeyCode as a keyboard event, should a popup be opened for this content control? More...
 
void dumpAsXml (xmlTextWriterPtr pWriter) const
 
void SetDataBindingPrefixMappings (const OUString &rDataBindingPrefixMappings)
 
const OUString & GetDataBindingPrefixMappings () const
 
void SetDataBindingXpath (const OUString &rDataBindingXpath)
 
const OUString & GetDataBindingXpath () const
 
void SetDataBindingStoreItemID (const OUString &rDataBindingStoreItemID)
 
const OUString & GetDataBindingStoreItemID () const
 
void SetColor (const OUString &rColor)
 
const OUString & GetColor () const
 
void SetAppearance (const OUString &rAppearance)
 
const OUString & GetAppearance () const
 
void SetAlias (const OUString &rAlias)
 
const OUString & GetAlias () const
 
void SetTag (const OUString &rTag)
 
const OUString & GetTag () const
 
void SetId (sal_Int32 nId)
 
sal_Int32 GetId () const
 
void SetTabIndex (sal_uInt32 nTabIndex)
 
sal_uInt32 GetTabIndex () const
 
void SetLock (bool bLockContent, bool bLockControl)
 
void SetLock (const OUString &rLock)
 
std::optional< bool > GetLock (bool bControl) const
 
const OUString & GetLock () const
 
void SetReadWrite (bool bReadWrite)
 
bool GetReadWrite () const
 
SwContentControlType GetType () const
 

Private Attributes

unotools::WeakReference< SwXContentControl > m_wXContentControl
 
SwFormatContentControl * m_pFormat
 
SwTextNode * m_pTextNode
 Can be nullptr if not in a document for undo purposes. More...
 
bool m_bShowingPlaceHolder = false
 Current content is placeholder text. More...
 
bool m_bCheckbox = false
 Display the content control as a checkbox. More...
 
bool m_bChecked = false
 If m_bCheckbox is true, is the checkbox checked? More...
 
OUString m_aCheckedState
 If m_bCheckbox is true, the value of a checked checkbox. More...
 
OUString m_aUncheckedState
 If m_bCheckbox is true, the value of an unchecked checkbox. More...
 
std::vector< SwContentControlListItem > m_aListItems
 
bool m_bPicture = false
 
bool m_bDate = false
 
OUString m_aDateFormat
 If m_bDate is true, the date format in a syntax accepted by SvNumberFormatter::PutEntry(). More...
 
OUString m_aDateLanguage
 If m_bDate is true, the date's BCP 47 language tag. More...
 
OUString m_aCurrentDate
 Date in YYYY-MM-DDT00:00:00Z format. More...
 
bool m_bPlainText = false
 Plain text, i.e. not rich text. More...
 
bool m_bComboBox = false
 Same as drop-down, but free-form input is also accepted. More...
 
bool m_bDropDown = false
 Same as combo box, but free-form input is not accepted. More...
 
OUString m_aPlaceholderDocPart
 The placeholder's doc part: just remembered. More...
 
OUString m_aDataBindingPrefixMappings
 The data bindings's prefix mappings: just remembered. More...
 
OUString m_aDataBindingXpath
 The data bindings's XPath: just remembered. More...
 
OUString m_aDataBindingStoreItemID
 The data bindings's store item ID: just remembered. More...
 
OUString m_aColor
 The color: just remembered. More...
 
OUString m_aAppearance
 The appearance: just remembered. More...
 
OUString m_aAlias
 The alias: just remembered. More...
 
OUString m_aTag
 The tag: just remembered. More...
 
sal_Int32 m_nId = 0
 The id: just remembered. More...
 
sal_uInt32 m_nTabIndex = 0
 The tabIndex: just remembered. More...
 
OUString m_aLock
 The control and content locks: mostly just remembered. More...
 
std::optional< size_t > m_oSelectedListItem
 Stores a list item index, in case the doc model is not yet updated. More...
 
std::optional< double > m_oSelectedDate
 Stores a date timestamp, in case the doc model is not yet updated. More...
 
bool m_bReadWrite = false
 E.g. More...
 

Detailed Description

Stores the properties of a content control.

Definition at line 110 of file formatcontentcontrol.hxx.

Constructor & Destructor Documentation

◆ SwContentControl()

SwContentControl::SwContentControl ( SwFormatContentControl *  pFormat)
explicit

Definition at line 181 of file attrcontentcontrol.cxx.

References SwFormatContentControl::GetContentControl(), SetAlias(), SetAppearance(), SetCheckbox(), SetChecked(), SetCheckedState(), SetColor(), SetComboBox(), SetCurrentDate(), SetDataBindingPrefixMappings(), SetDataBindingStoreItemID(), SetDataBindingXpath(), SetDate(), SetDateFormat(), SetDateLanguage(), SetDropDown(), SetId(), SetListItems(), SetLock(), SetPicture(), SetPlaceholderDocPart(), SetPlainText(), SetShowingPlaceHolder(), SetTabIndex(), SetTag(), and SetUncheckedState().

◆ ~SwContentControl()

SwContentControl::~SwContentControl ( )
overridevirtual

Definition at line 224 of file attrcontentcontrol.cxx.

Member Function Documentation

◆ AddListItem()

bool SwContentControl::AddListItem ( size_t  nZIndex,
const OUString &  rDisplayText,
const OUString &  rValue 
)

Definition at line 290 of file attrcontentcontrol.cxx.

References GetListItems(), GetSelectedListItem(), SwContentControlListItem::m_aDisplayText, SwContentControlListItem::m_aValue, min(), SetListItems(), and SetSelectedListItem().

◆ ClearListItems()

void SwContentControl::ClearListItems ( )

Definition at line 351 of file attrcontentcontrol.cxx.

References GetTextAttr(), SwTextContentControl::Invalidate(), m_bDropDown, SetListItems(), and SetSelectedListItem().

◆ DeleteListItem()

void SwContentControl::DeleteListItem ( size_t  nZIndex)

Definition at line 327 of file attrcontentcontrol.cxx.

References GetListItems(), GetSelectedListItem(), GetTextAttr(), SwTextContentControl::Invalidate(), m_bDropDown, SetListItems(), SetSelectedListItem(), and size.

◆ dumpAsXml()

void SwContentControl::dumpAsXml ( xmlTextWriterPtr  pWriter) const

Definition at line 555 of file attrcontentcontrol.cxx.

References m_aAlias, m_aAppearance, m_aCheckedState, m_aColor, m_aCurrentDate, m_aDataBindingPrefixMappings, m_aDataBindingStoreItemID, m_aDataBindingXpath, m_aDateFormat, m_aDateLanguage, m_aListItems, m_aLock, m_aPlaceholderDocPart, m_aTag, m_aUncheckedState, m_bCheckbox, m_bChecked, m_bComboBox, m_bDate, m_bDropDown, m_bPicture, m_bPlainText, m_bShowingPlaceHolder, m_nId, and m_nTabIndex.

◆ GetAlias()

const OUString & SwContentControl::GetAlias ( ) const
inline

Definition at line 365 of file formatcontentcontrol.hxx.

Referenced by SwContentControlAliasButton::SetContentControl().

◆ GetAppearance()

const OUString & SwContentControl::GetAppearance ( ) const
inline

Definition at line 361 of file formatcontentcontrol.hxx.

◆ GetCheckbox()

bool SwContentControl::GetCheckbox ( ) const
inline

Definition at line 238 of file formatcontentcontrol.hxx.

Referenced by IsInteractingCharacter().

◆ GetChecked()

bool SwContentControl::GetChecked ( ) const
inline

Definition at line 242 of file formatcontentcontrol.hxx.

◆ GetCheckedState()

const OUString & SwContentControl::GetCheckedState ( ) const
inline

Definition at line 246 of file formatcontentcontrol.hxx.

◆ GetColor()

const OUString & SwContentControl::GetColor ( ) const
inline

Definition at line 357 of file formatcontentcontrol.hxx.

References m_aColor.

◆ GetComboBox()

bool SwContentControl::GetComboBox ( ) const
inline

Definition at line 298 of file formatcontentcontrol.hxx.

◆ GetCurrentDate()

const OUString & SwContentControl::GetCurrentDate ( ) const
inline

Definition at line 281 of file formatcontentcontrol.hxx.

◆ GetCurrentDateValue()

double SwContentControl::GetCurrentDateValue ( ) const

Parses m_aCurrentDate and returns it.

Definition at line 422 of file attrcontentcontrol.cxx.

References SwNode::GetDoc(), SvNumberFormatter::GetEntryKey(), SwDoc::GetNumberFormatter(), SvNumberFormatter::IsNumberFormat(), LANGUAGE_ENGLISH_US, m_aCurrentDate, m_pTextNode, nType, NUMBERFORMAT_ENTRY_NOT_FOUND, and SvNumberFormatter::PutEntry().

Referenced by GetDateString().

◆ GetDataBindingPrefixMappings()

const OUString & SwContentControl::GetDataBindingPrefixMappings ( ) const
inline

Definition at line 339 of file formatcontentcontrol.hxx.

◆ GetDataBindingStoreItemID()

const OUString & SwContentControl::GetDataBindingStoreItemID ( ) const
inline

Definition at line 353 of file formatcontentcontrol.hxx.

◆ GetDataBindingXpath()

const OUString & SwContentControl::GetDataBindingXpath ( ) const
inline

Definition at line 346 of file formatcontentcontrol.hxx.

◆ GetDate()

bool SwContentControl::GetDate ( ) const
inline

Definition at line 269 of file formatcontentcontrol.hxx.

◆ GetDateFormat()

const OUString & SwContentControl::GetDateFormat ( ) const
inline

Definition at line 273 of file formatcontentcontrol.hxx.

◆ GetDateLanguage()

const OUString & SwContentControl::GetDateLanguage ( ) const
inline

Definition at line 277 of file formatcontentcontrol.hxx.

◆ GetDateString()

OUString SwContentControl::GetDateString ( ) const

Formats m_oSelectedDate, taking m_aDateFormat and m_aDateLanguage into account.

Definition at line 359 of file attrcontentcontrol.cxx.

References GetCurrentDateValue(), SwNode::GetDoc(), SvNumberFormatter::GetEntryKey(), SwDoc::GetNumberFormatter(), SvNumberFormatter::GetOutputString(), m_aDateFormat, m_aDateLanguage, m_oSelectedDate, m_pTextNode, nType, NUMBERFORMAT_ENTRY_NOT_FOUND, and SvNumberFormatter::PutEntry().

◆ GetDropDown()

bool SwContentControl::GetDropDown ( ) const
inline

Definition at line 302 of file formatcontentcontrol.hxx.

Referenced by GetSelectedListItem().

◆ GetFormatContentControl()

SwFormatContentControl * SwContentControl::GetFormatContentControl ( ) const
inline

Definition at line 210 of file formatcontentcontrol.hxx.

◆ GetId()

sal_Int32 SwContentControl::GetId ( ) const
inline

Definition at line 373 of file formatcontentcontrol.hxx.

◆ GetListItems()

const std::vector< SwContentControlListItem > & SwContentControl::GetListItems ( ) const
inline

Definition at line 252 of file formatcontentcontrol.hxx.

Referenced by AddListItem(), DeleteListItem(), and GetSelectedListItem().

◆ GetLock() [1/2]

const OUString & SwContentControl::GetLock ( ) const
inline

Definition at line 385 of file formatcontentcontrol.hxx.

◆ GetLock() [2/2]

std::optional< bool > SwContentControl::GetLock ( bool  bControl) const

Definition at line 490 of file attrcontentcontrol.cxx.

References m_aLock.

◆ GetPicture()

bool SwContentControl::GetPicture ( ) const
inline

Definition at line 265 of file formatcontentcontrol.hxx.

Referenced by IsInteractingCharacter().

◆ GetPlaceholderDocPart()

const OUString & SwContentControl::GetPlaceholderDocPart ( ) const
inline

Definition at line 309 of file formatcontentcontrol.hxx.

◆ GetPlainText()

bool SwContentControl::GetPlainText ( ) const
inline

Definition at line 294 of file formatcontentcontrol.hxx.

◆ GetReadWrite()

bool SwContentControl::GetReadWrite ( ) const
inline

Definition at line 390 of file formatcontentcontrol.hxx.

◆ GetSelectedDate()

const std::optional< double > & SwContentControl::GetSelectedDate ( ) const
inline

Definition at line 324 of file formatcontentcontrol.hxx.

◆ GetSelectedListItem() [1/2]

const std::optional< size_t > & SwContentControl::GetSelectedListItem ( ) const
inline

Definition at line 316 of file formatcontentcontrol.hxx.

Referenced by AddListItem(), and DeleteListItem().

◆ GetSelectedListItem() [2/2]

std::optional< size_t > SwContentControl::GetSelectedListItem ( bool  bCheckDocModel) const

Get a copy of selected list item's index, potentially even if the selection is already written out to text (i.e.

validated).

Definition at line 271 of file attrcontentcontrol.cxx.

References GetDropDown(), GetListItems(), GetShowingPlaceHolder(), GetTextAttr(), i, m_oSelectedListItem, and SwTextContentControl::ToString().

◆ GetShowingPlaceHolder()

bool SwContentControl::GetShowingPlaceHolder ( ) const
inline

Definition at line 234 of file formatcontentcontrol.hxx.

Referenced by GetSelectedListItem().

◆ GetTabIndex()

sal_uInt32 SwContentControl::GetTabIndex ( ) const
inline

Definition at line 377 of file formatcontentcontrol.hxx.

◆ GetTag()

const OUString & SwContentControl::GetTag ( ) const
inline

Definition at line 369 of file formatcontentcontrol.hxx.

◆ GetTextAttr()

SwTextContentControl * SwContentControl::GetTextAttr ( ) const

Definition at line 231 of file attrcontentcontrol.cxx.

References SwFormatContentControl::GetTextAttr(), and m_pFormat.

Referenced by ClearListItems(), DeleteListItem(), GetSelectedListItem(), and SwXContentControl::SetContentRange().

◆ GetTextNode()

SwTextNode * SwContentControl::GetTextNode ( ) const
inline

Definition at line 208 of file formatcontentcontrol.hxx.

Referenced by SwXContentControl::SetContentRange().

◆ GetType()

SwContentControlType SwContentControl::GetType ( ) const

Definition at line 520 of file attrcontentcontrol.cxx.

References CHECKBOX, COMBO_BOX, DATE, DROP_DOWN_LIST, m_bCheckbox, m_bComboBox, m_bDate, m_bDropDown, m_bPicture, m_bPlainText, PICTURE, PLAIN_TEXT, and RICH_TEXT.

Referenced by ShouldOpenPopup().

◆ GetUncheckedState()

const OUString & SwContentControl::GetUncheckedState ( ) const
inline

Definition at line 250 of file formatcontentcontrol.hxx.

◆ GetXContentControl()

const unotools::WeakReference< SwXContentControl > & SwContentControl::GetXContentControl ( ) const
inline

Definition at line 216 of file formatcontentcontrol.hxx.

◆ IsInteractingCharacter()

bool SwContentControl::IsInteractingCharacter ( sal_Unicode  cCh)

Should this character (during key input) interact with the content control?

Definition at line 451 of file attrcontentcontrol.cxx.

References GetCheckbox(), and GetPicture().

◆ NotifyChangeTextNode()

void SwContentControl::NotifyChangeTextNode ( SwTextNode *  pTextNode)

Definition at line 236 of file attrcontentcontrol.cxx.

References m_pTextNode.

◆ SetAlias()

void SwContentControl::SetAlias ( const OUString &  rAlias)
inline

Definition at line 363 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetAppearance()

void SwContentControl::SetAppearance ( const OUString &  rAppearance)
inline

Definition at line 359 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetCheckbox()

void SwContentControl::SetCheckbox ( bool  bCheckbox)
inline

Definition at line 236 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetChecked()

void SwContentControl::SetChecked ( bool  bChecked)
inline

Definition at line 240 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetCheckedState()

void SwContentControl::SetCheckedState ( const OUString &  rCheckedState)
inline

Definition at line 244 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetColor()

void SwContentControl::SetColor ( const OUString &  rColor)
inline

Definition at line 355 of file formatcontentcontrol.hxx.

References m_aColor.

Referenced by SwContentControl().

◆ SetComboBox()

void SwContentControl::SetComboBox ( bool  bComboBox)
inline

Definition at line 296 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetCurrentDate()

void SwContentControl::SetCurrentDate ( const OUString &  rCurrentDate)
inline

Definition at line 279 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetCurrentDateValue()

void SwContentControl::SetCurrentDateValue ( double  fCurrentDate)

Formats fCurrentDate and sets it.

Definition at line 397 of file attrcontentcontrol.cxx.

References SwNode::GetDoc(), SvNumberFormatter::GetEntryKey(), SwDoc::GetNumberFormatter(), SvNumberFormatter::GetOutputString(), LANGUAGE_ENGLISH_US, m_aCurrentDate, m_pTextNode, nType, NUMBERFORMAT_ENTRY_NOT_FOUND, and SvNumberFormatter::PutEntry().

◆ SetDataBindingPrefixMappings()

void SwContentControl::SetDataBindingPrefixMappings ( const OUString &  rDataBindingPrefixMappings)
inline

Definition at line 334 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetDataBindingStoreItemID()

void SwContentControl::SetDataBindingStoreItemID ( const OUString &  rDataBindingStoreItemID)
inline

Definition at line 348 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetDataBindingXpath()

void SwContentControl::SetDataBindingXpath ( const OUString &  rDataBindingXpath)
inline

Definition at line 341 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetDate()

void SwContentControl::SetDate ( bool  bDate)
inline

Definition at line 267 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetDateFormat()

void SwContentControl::SetDateFormat ( const OUString &  rDateFormat)
inline

Definition at line 271 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetDateLanguage()

void SwContentControl::SetDateLanguage ( const OUString &  rDateLanguage)
inline

Definition at line 275 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetDropDown()

void SwContentControl::SetDropDown ( bool  bDropDown)
inline

Definition at line 300 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetFormatContentControl()

void SwContentControl::SetFormatContentControl ( SwFormatContentControl *  pFormat)
inline

Definition at line 212 of file formatcontentcontrol.hxx.

◆ SetId()

void SwContentControl::SetId ( sal_Int32  nId)
inline

Definition at line 371 of file formatcontentcontrol.hxx.

References nId.

Referenced by SwContentControl().

◆ SetListItems()

void SwContentControl::SetListItems ( const std::vector< SwContentControlListItem > &  rListItems)
inline

Definition at line 254 of file formatcontentcontrol.hxx.

Referenced by AddListItem(), ClearListItems(), DeleteListItem(), and SwContentControl().

◆ SetLock() [1/2]

void SwContentControl::SetLock ( bool  bLockContent,
bool  bLockControl 
)

Definition at line 508 of file attrcontentcontrol.cxx.

References m_aLock.

Referenced by SwContentControl().

◆ SetLock() [2/2]

void SwContentControl::SetLock ( const OUString &  rLock)
inline

Definition at line 381 of file formatcontentcontrol.hxx.

◆ SetPicture()

void SwContentControl::SetPicture ( bool  bPicture)
inline

Definition at line 263 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetPlaceholderDocPart()

void SwContentControl::SetPlaceholderDocPart ( const OUString &  rPlaceholderDocPart)
inline

Definition at line 304 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetPlainText()

void SwContentControl::SetPlainText ( bool  bPlainText)
inline

Definition at line 292 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetReadWrite()

void SwContentControl::SetReadWrite ( bool  bReadWrite)
inline

Definition at line 387 of file formatcontentcontrol.hxx.

◆ SetSelectedDate()

void SwContentControl::SetSelectedDate ( std::optional< double >  oSelectedDate)
inline

Definition at line 322 of file formatcontentcontrol.hxx.

◆ SetSelectedListItem()

void SwContentControl::SetSelectedListItem ( std::optional< size_t >  oSelectedListItem)
inline

Definition at line 311 of file formatcontentcontrol.hxx.

Referenced by AddListItem(), ClearListItems(), and DeleteListItem().

◆ SetShowingPlaceHolder()

void SwContentControl::SetShowingPlaceHolder ( bool  bShowingPlaceHolder)
inline

Definition at line 229 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetTabIndex()

void SwContentControl::SetTabIndex ( sal_uInt32  nTabIndex)
inline

Definition at line 375 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetTag()

void SwContentControl::SetTag ( const OUString &  rTag)
inline

Definition at line 367 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetUncheckedState()

void SwContentControl::SetUncheckedState ( const OUString &  rUncheckedState)
inline

Definition at line 248 of file formatcontentcontrol.hxx.

Referenced by SwContentControl().

◆ SetXContentControl()

void SwContentControl::SetXContentControl ( const rtl::Reference< SwXContentControl > &  xContentControl)

Definition at line 226 of file attrcontentcontrol.cxx.

References m_wXContentControl.

Referenced by SwClientNotify().

◆ ShouldOpenPopup()

bool SwContentControl::ShouldOpenPopup ( const vcl::KeyCode &  rKeyCode)

Given rKeyCode as a keyboard event, should a popup be opened for this content control?

Definition at line 466 of file attrcontentcontrol.cxx.

References COMBO_BOX, DATE, DROP_DOWN_LIST, vcl::KeyCode::GetCode(), GetType(), vcl::KeyCode::IsMod2(), and KEY_DOWN.

◆ SwClientNotify()

void SwContentControl::SwClientNotify ( const SwModify &  ,
const SfxHint &  rHint 
)
overridevirtual

Definition at line 254 of file attrcontentcontrol.cxx.

References SfxHint::GetId(), RES_REMOVE_UNO_OBJECT(), and SetXContentControl().

Member Data Documentation

◆ m_aAlias

OUString SwContentControl::m_aAlias
private

The alias: just remembered.

Definition at line 177 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aAppearance

OUString SwContentControl::m_aAppearance
private

The appearance: just remembered.

Definition at line 174 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aCheckedState

OUString SwContentControl::m_aCheckedState
private

If m_bCheckbox is true, the value of a checked checkbox.

Definition at line 129 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aColor

OUString SwContentControl::m_aColor
private

The color: just remembered.

Definition at line 171 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aCurrentDate

OUString SwContentControl::m_aCurrentDate
private

Date in YYYY-MM-DDT00:00:00Z format.

Definition at line 147 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), GetCurrentDateValue(), and SetCurrentDateValue().

◆ m_aDataBindingPrefixMappings

OUString SwContentControl::m_aDataBindingPrefixMappings
private

The data bindings's prefix mappings: just remembered.

Definition at line 162 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aDataBindingStoreItemID

OUString SwContentControl::m_aDataBindingStoreItemID
private

The data bindings's store item ID: just remembered.

Definition at line 168 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aDataBindingXpath

OUString SwContentControl::m_aDataBindingXpath
private

The data bindings's XPath: just remembered.

Definition at line 165 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aDateFormat

OUString SwContentControl::m_aDateFormat
private

If m_bDate is true, the date format in a syntax accepted by SvNumberFormatter::PutEntry().

Definition at line 141 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetDateString().

◆ m_aDateLanguage

OUString SwContentControl::m_aDateLanguage
private

If m_bDate is true, the date's BCP 47 language tag.

Definition at line 144 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetDateString().

◆ m_aListItems

std::vector<SwContentControlListItem> SwContentControl::m_aListItems
private

Definition at line 134 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aLock

OUString SwContentControl::m_aLock
private

The control and content locks: mostly just remembered.

Definition at line 189 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), GetLock(), and SetLock().

◆ m_aPlaceholderDocPart

OUString SwContentControl::m_aPlaceholderDocPart
private

The placeholder's doc part: just remembered.

Definition at line 159 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aTag

OUString SwContentControl::m_aTag
private

The tag: just remembered.

Definition at line 180 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_aUncheckedState

OUString SwContentControl::m_aUncheckedState
private

If m_bCheckbox is true, the value of an unchecked checkbox.

Definition at line 132 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_bCheckbox

bool SwContentControl::m_bCheckbox = false
private

Display the content control as a checkbox.

Definition at line 123 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetType().

◆ m_bChecked

bool SwContentControl::m_bChecked = false
private

If m_bCheckbox is true, is the checkbox checked?

Definition at line 126 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_bComboBox

bool SwContentControl::m_bComboBox = false
private

Same as drop-down, but free-form input is also accepted.

Definition at line 153 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetType().

◆ m_bDate

bool SwContentControl::m_bDate = false
private

Definition at line 138 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetType().

◆ m_bDropDown

bool SwContentControl::m_bDropDown = false
private

Same as combo box, but free-form input is not accepted.

Definition at line 156 of file formatcontentcontrol.hxx.

Referenced by ClearListItems(), DeleteListItem(), dumpAsXml(), and GetType().

◆ m_bPicture

bool SwContentControl::m_bPicture = false
private

Definition at line 136 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetType().

◆ m_bPlainText

bool SwContentControl::m_bPlainText = false
private

Plain text, i.e. not rich text.

Definition at line 150 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml(), and GetType().

◆ m_bReadWrite

bool SwContentControl::m_bReadWrite = false
private

E.g.

checkbox is read-only by default, but we still update contents on interaction internally. This flag is true for the duration of that interaction.

Definition at line 203 of file formatcontentcontrol.hxx.

◆ m_bShowingPlaceHolder

bool SwContentControl::m_bShowingPlaceHolder = false
private

Current content is placeholder text.

Definition at line 120 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_nId

sal_Int32 SwContentControl::m_nId = 0
private

The id: just remembered.

Definition at line 183 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_nTabIndex

sal_uInt32 SwContentControl::m_nTabIndex = 0
private

The tabIndex: just remembered.

Definition at line 186 of file formatcontentcontrol.hxx.

Referenced by dumpAsXml().

◆ m_oSelectedDate

std::optional<double> SwContentControl::m_oSelectedDate
private

Stores a date timestamp, in case the doc model is not yet updated.

Definition at line 197 of file formatcontentcontrol.hxx.

Referenced by GetDateString().

◆ m_oSelectedListItem

std::optional<size_t> SwContentControl::m_oSelectedListItem
private

Stores a list item index, in case the doc model is not yet updated.

Definition at line 193 of file formatcontentcontrol.hxx.

Referenced by GetSelectedListItem().

◆ m_pFormat

SwFormatContentControl* SwContentControl::m_pFormat
private

Definition at line 114 of file formatcontentcontrol.hxx.

Referenced by GetTextAttr().

◆ m_pTextNode

SwTextNode* SwContentControl::m_pTextNode
private

Can be nullptr if not in a document for undo purposes.

Definition at line 117 of file formatcontentcontrol.hxx.

Referenced by GetCurrentDateValue(), GetDateString(), NotifyChangeTextNode(), and SetCurrentDateValue().

◆ m_wXContentControl

unotools::WeakReference<SwXContentControl> SwContentControl::m_wXContentControl
private

Definition at line 112 of file formatcontentcontrol.hxx.

Referenced by SetXContentControl().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:30:55 for LibreOffice Module sw (master) by doxygen 1.9.3