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

#include <expfld.hxx>

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

Public Member Functions

 SwInputField (SwInputFieldType *pFieldType, OUString aContent, OUString aPrompt, sal_uInt16 nSubType, sal_uLong nFormat=0, bool bIsFormField=true)
 Direct input via dialog; delete old value. More...
 
virtual ~SwInputField () override
 
void SetFormatField (SwFormatField &rFormatField)
 
SwFormatFieldGetFormatField ()
 
void applyFieldContent (const OUString &rNewFieldContent)
 
bool isFormField () const
 
const css::uno::Sequence< css::beans::PropertyValue > & getGrabBagParams () const
 
virtual OUString GetFieldName () const override
 get name or content More...
 
virtual OUString GetPar1 () const override
 Content. More...
 
virtual void SetPar1 (const OUString &rStr) override
 set condition More...
 
virtual OUString GetPar2 () const override
 aPromptText More...
 
virtual void SetPar2 (const OUString &rStr) override
 
const OUString & GetHelp () const
 
void SetHelp (const OUString &rStr)
 
const OUString & GetToolTip () const
 
void SetToolTip (const OUString &rStr)
 
virtual sal_uInt16 GetSubType () const override
 
virtual void SetSubType (sal_uInt16 nSub) override
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhich) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhich) override
 
- Public Member Functions inherited from SwField
virtual ~SwField ()
 
 SwField (SwField const &)=default
 
 SwField (SwField &&)=default
 
SwFieldoperator= (SwField const &)=default
 
SwFieldoperator= (SwField &&)=default
 
SwFieldTypeGetTyp () const
 
virtual SwFieldTypeChgTyp (SwFieldType *)
 Set new type (used for copying among documents). More...
 
OUString ExpandField (bool bCached, SwRootFrame const *pLayout) const
 expand the field. More...
 
virtual OUString GetFieldName () const
 get name or content More...
 
std::unique_ptr< SwFieldCopyField () const
 
SwFieldIds Which () const
 ResId. More...
 
SwFieldTypesEnum GetTypeId () const
 
virtual sal_uInt16 GetSubType () const
 
virtual void SetSubType (sal_uInt16)
 
LanguageType GetLanguage () const
 Language at field position. More...
 
virtual void SetLanguage (LanguageType nLng)
 
sal_uInt32 GetFormat () const
 Query parameters for dialog and for BASIC. More...
 
virtual OUString GetPar1 () const
 
virtual OUString GetPar2 () const
 
virtual OUString GetFormula () const
 
void ChangeFormat (sal_uInt32 n)
 
virtual void SetPar1 (const OUString &rStr)
 
virtual void SetPar2 (const OUString &rStr)
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt16 nWhichId) const
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt16 nWhichId)
 
bool HasClickHdl () const
 Does the field possess an action on its ClickHandler? (e.g. INetFields, ...). More...
 
bool IsFixed () const
 
bool IsAutomaticLanguage () const
 
void SetAutomaticLanguage (bool const bSet)
 
virtual OUString GetDescription () const
 
bool IsClickable () const
 Is this field clickable? More...
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
const OUString & GetTitle () const
 
void SetTitle (const OUString &rTitle)
 

Private Member Functions

virtual OUString ExpandImpl (SwRootFrame const *pLayout) const override
 
virtual std::unique_ptr< SwFieldCopy () const override
 
const OUString & getContent () const
 

Private Attributes

OUString maContent
 
OUString maPText
 
OUString maHelp
 
OUString maToolTip
 
sal_uInt16 mnSubType
 
bool mbIsFormField
 
css::uno::Sequence< css::beans::PropertyValue > maGrabBag
 
SwFormatFieldmpFormatField
 

Additional Inherited Members

- Protected Member Functions inherited from SwField
void SetFormat (sal_uInt32 const nSet)
 
 SwField (SwFieldType *pTyp, sal_uInt32 nFormat=0, LanguageType nLang=LANGUAGE_SYSTEM, bool m_bUseFieldValueCache=true)
 

Detailed Description

Definition at line 286 of file expfld.hxx.

Constructor & Destructor Documentation

◆ SwInputField()

SwInputField::SwInputField ( SwInputFieldType pFieldType,
OUString  aContent,
OUString  aPrompt,
sal_uInt16  nSubType,
sal_uLong  nFormat = 0,
bool  bIsFormField = true 
)

Direct input via dialog; delete old value.

Definition at line 1217 of file expfld.cxx.

References LANGUAGE_SYSTEM.

Referenced by Copy().

◆ ~SwInputField()

SwInputField::~SwInputField ( )
overridevirtual

Definition at line 1232 of file expfld.cxx.

Member Function Documentation

◆ applyFieldContent()

void SwInputField::applyFieldContent ( const OUString &  rNewFieldContent)

◆ Copy()

std::unique_ptr< SwField > SwInputField::Copy ( ) const
overrideprivatevirtual

◆ ExpandImpl()

OUString SwInputField::ExpandImpl ( SwRootFrame const *  pLayout) const
overrideprivatevirtual

Implements SwField.

Definition at line 1313 of file expfld.cxx.

References getContent(), SwUserFieldType::GetContent(), SwField::GetTyp(), INP_TXT, INP_USR, mnSubType, and User.

◆ getContent()

const OUString & SwInputField::getContent ( ) const
inlineprivate

Definition at line 302 of file expfld.hxx.

Referenced by applyFieldContent(), Copy(), ExpandImpl(), GetFieldName(), GetPar1(), and QueryValue().

◆ GetFieldName()

OUString SwInputField::GetFieldName ( ) const
overridevirtual

get name or content

Returns
name or content.

Reimplemented from SwField.

Definition at line 1284 of file expfld.cxx.

References aStr, getContent(), SwField::GetFieldName(), SwFieldType::GetName(), SwField::GetTyp(), INP_USR, and mnSubType.

◆ GetFormatField()

SwFormatField * SwInputField::GetFormatField ( )
inline

Definition at line 316 of file expfld.hxx.

Referenced by applyFieldContent(), and SwFieldEditDlg::EnsureSelection().

◆ getGrabBagParams()

const css::uno::Sequence< css::beans::PropertyValue > & SwInputField::getGrabBagParams ( ) const
inline

◆ GetHelp()

const OUString & SwInputField::GetHelp ( ) const

Definition at line 1418 of file expfld.cxx.

References maHelp.

Referenced by RtfExport::DoFormText(), and WW8Export::DoFormText().

◆ GetPar1()

OUString SwInputField::GetPar1 ( ) const
overridevirtual

Content.

Reimplemented from SwField.

Definition at line 1398 of file expfld.cxx.

References getContent().

Referenced by SwFieldInputDlg::Apply(), DocxAttributeOutput::StartField_Impl(), and SwFieldInputDlg::SwFieldInputDlg().

◆ GetPar2()

OUString SwInputField::GetPar2 ( ) const
overridevirtual

aPromptText

Reimplemented from SwField.

Definition at line 1408 of file expfld.cxx.

References maPText.

Referenced by DocxExport::DoFormText(), RtfExport::DoFormText(), WW8Export::DoFormText(), and SwFieldInputDlg::SwFieldInputDlg().

◆ GetSubType()

sal_uInt16 SwInputField::GetSubType ( ) const
overridevirtual

Reimplemented from SwField.

Definition at line 1433 of file expfld.cxx.

References mnSubType.

Referenced by Copy(), and SwFieldInputDlg::SwFieldInputDlg().

◆ GetToolTip()

const OUString & SwInputField::GetToolTip ( ) const

Definition at line 1428 of file expfld.cxx.

References maToolTip.

Referenced by RtfExport::DoFormText(), and WW8Export::DoFormText().

◆ isFormField()

bool SwInputField::isFormField ( ) const

Definition at line 1331 of file expfld.cxx.

References maHelp, maToolTip, and mbIsFormField.

Referenced by AttributeOutputBase::TextField().

◆ PutValue()

bool SwInputField::PutValue ( const css::uno::Any &  rVal,
sal_uInt16  nWhich 
)
overridevirtual

◆ QueryValue()

bool SwInputField::QueryValue ( css::uno::Any &  rVal,
sal_uInt16  nWhich 
) const
overridevirtual

◆ SetFormatField()

void SwInputField::SetFormatField ( SwFormatField rFormatField)

Definition at line 1236 of file expfld.cxx.

References mpFormatField.

Referenced by SwFormatField::SwFormatField().

◆ SetHelp()

void SwInputField::SetHelp ( const OUString &  rStr)

Definition at line 1413 of file expfld.cxx.

References maHelp.

Referenced by SwXTextField::attach(), and SwWW8ImplReader::Read_F_FormTextBox().

◆ SetPar1()

void SwInputField::SetPar1 ( const OUString &  rStr)
overridevirtual

set condition

Reimplemented from SwField.

Definition at line 1393 of file expfld.cxx.

References maContent.

Referenced by SwFieldInputDlg::Apply().

◆ SetPar2()

void SwInputField::SetPar2 ( const OUString &  rStr)
overridevirtual

Reimplemented from SwField.

Definition at line 1403 of file expfld.cxx.

References maPText.

◆ SetSubType()

void SwInputField::SetSubType ( sal_uInt16  nSub)
overridevirtual

Reimplemented from SwField.

Definition at line 1438 of file expfld.cxx.

References mnSubType.

◆ SetToolTip()

void SwInputField::SetToolTip ( const OUString &  rStr)

Definition at line 1423 of file expfld.cxx.

References maToolTip.

Referenced by SwXTextField::attach(), and SwWW8ImplReader::Read_F_FormTextBox().

Member Data Documentation

◆ maContent

OUString SwInputField::maContent
mutableprivate

Definition at line 288 of file expfld.hxx.

Referenced by applyFieldContent(), PutValue(), and SetPar1().

◆ maGrabBag

css::uno::Sequence<css::beans::PropertyValue> SwInputField::maGrabBag
private

Definition at line 294 of file expfld.hxx.

Referenced by Copy(), PutValue(), and QueryValue().

◆ maHelp

OUString SwInputField::maHelp
private

Definition at line 290 of file expfld.hxx.

Referenced by Copy(), GetHelp(), isFormField(), PutValue(), QueryValue(), and SetHelp().

◆ maPText

OUString SwInputField::maPText
private

Definition at line 289 of file expfld.hxx.

Referenced by Copy(), GetPar2(), PutValue(), QueryValue(), and SetPar2().

◆ maToolTip

OUString SwInputField::maToolTip
private

Definition at line 291 of file expfld.hxx.

Referenced by Copy(), GetToolTip(), isFormField(), PutValue(), QueryValue(), and SetToolTip().

◆ mbIsFormField

bool SwInputField::mbIsFormField
private

Definition at line 293 of file expfld.hxx.

Referenced by Copy(), and isFormField().

◆ mnSubType

sal_uInt16 SwInputField::mnSubType
private

Definition at line 292 of file expfld.hxx.

Referenced by applyFieldContent(), ExpandImpl(), GetFieldName(), GetSubType(), and SetSubType().

◆ mpFormatField

SwFormatField* SwInputField::mpFormatField
private

Definition at line 296 of file expfld.hxx.

Referenced by SetFormatField().


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