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

A section node represents the start of a section on the UI, i.e. More...

#include <node.hxx>

Inheritance diagram for SwSectionNode:
Collaboration diagram for SwSectionNode:

Public Member Functions

 SwSectionNode (const SwNode &rWhere, SwSectionFormat &rFormat, SwTOXBase const *const pTOXBase)
const SwSectionGetSection () const
SwSectionGetSection ()
SwFrameMakeFrame (SwFrame *)
void MakeOwnFrames (SwNodeIndex *pIdxBehind, SwNodeIndex *pEnd=nullptr)
 Creates the frms for the SectionNode (i.e. More...
void DelFrames (SwRootFrame const *pLayout=nullptr, bool bForce=false)
 Method deletes all views of document for the node. More...
void MakeFramesForAdjacentContentNode (const SwNodeIndex &rIdx)
 Method creates all views of document for the previous node. More...
SwSectionNodeMakeCopy (SwDoc &, const SwNodeIndex &) const
void NodesArrChgd ()
 Set pointer in format of section on itself. More...
bool IsContentHidden () const
 Check for not hidden areas whether there is content that is not in a hidden sub-area. More...
void dumpAsXml (xmlTextWriterPtr pWriter) const override
 Dumps the node structure to the given destination (file nodes.xml in the current directory by default) More...
- Public Member Functions inherited from SwStartNode
SwStartNodeType GetStartNodeType () const
void CheckSectionCondColl () const
 Call ChkCondcoll to all ContentNodes of section. More...
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const override
 Dumps the node structure to the given destination (file nodes.xml in the current directory by default) More...
- Public Member Functions inherited from SwNode
bool IsCreateFrameWhenHidingRedlines () const
void SetRedlineMergeFlag (Merge const eMerge)
Merge GetRedlineMergeFlag () const
virtual ~SwNode () override=0
 the = 0 forces the class to be an abstract base class, but the dtor can be still called from subclasses More...
tools::Long GetSerial () const
sal_uInt16 GetSectionLevel () const
 Returns the section level at the position given by aIndex. More...
SwNodeOffset StartOfSectionIndex () const
const SwStartNodeStartOfSectionNode () const
SwStartNodeStartOfSectionNode ()
SwNodeOffset EndOfSectionIndex () const
const SwEndNodeEndOfSectionNode () const
SwEndNodeEndOfSectionNode ()
sal_uInt8 GetAutoFormatLvl () const
void SetAutoFormatLvl (sal_uInt8 nVal)
bool IsIgnoreDontExpand () const
void SetIgnoreDontExpand (bool bNew)
SwNodeType GetNodeType () const
SwStartNodeGetStartNode ()
const SwStartNodeGetStartNode () const
SwContentNodeGetContentNode ()
const SwContentNodeGetContentNode () const
SwEndNodeGetEndNode ()
const SwEndNodeGetEndNode () const
SwTextNodeGetTextNode ()
 Inline methods from Node.hxx. More...
const SwTextNodeGetTextNode () const
SwOLENodeGetOLENode ()
 Inline methods from Node.hxx. More...
const SwOLENodeGetOLENode () const
SwNoTextNodeGetNoTextNode ()
const SwNoTextNodeGetNoTextNode () const
SwGrfNodeGetGrfNode ()
const SwGrfNodeGetGrfNode () const
SwTableNodeGetTableNode ()
const SwTableNodeGetTableNode () const
SwSectionNodeGetSectionNode ()
const SwSectionNodeGetSectionNode () const
bool IsStartNode () const
bool IsContentNode () const
bool IsEndNode () const
bool IsTextNode () const
bool IsTableNode () const
bool IsSectionNode () const
bool IsOLENode () const
bool IsNoTextNode () const
bool IsGrfNode () const
bool IsInRedlines () const
 Checks if this node is in redlines. More...
SwTableNodeFindTableNode ()
 Search table node, in which it is. More...
const SwTableNodeFindTableNode () const
SwSectionNodeFindSectionNode ()
 Search section node, in which it is. More...
const SwSectionNodeFindSectionNode () const
SwStartNodeFindSttNodeByType (SwStartNodeType eTyp)
const SwStartNodeFindSttNodeByType (SwStartNodeType eTyp) const
const SwStartNodeFindTableBoxStartNode () const
const SwStartNodeFindFlyStartNode () const
const SwStartNodeFindFootnoteStartNode () const
const SwStartNodeFindHeaderStartNode () const
const SwStartNodeFindFooterStartNode () const
SwNodesGetNodes ()
 Node is in which nodes-array/doc? More...
const SwNodesGetNodes () const
SwDocGetDoc ()
const SwDocGetDoc () const
const IDocumentSettingAccessgetIDocumentSettingAccess () const
 Provides access to the document setting interface. More...
const IDocumentDeviceAccessgetIDocumentDeviceAccess () const
 Provides access to the document device interface. More...
const IDocumentMarkAccessgetIDocumentMarkAccess () const
 Provides access to the document bookmark interface. More...
const IDocumentRedlineAccessgetIDocumentRedlineAccess () const
 Provides access to the document redline interface. More...
const IDocumentStylePoolAccessgetIDocumentStylePoolAccess () const
 Provides access to the document style pool interface. More...
const IDocumentDrawModelAccessgetIDocumentDrawModelAccess () const
 Provides access to the document draw model interface. More...
const IDocumentLayoutAccessgetIDocumentLayoutAccess () const
 Provides access to the document layout interface. More...
IDocumentLayoutAccessgetIDocumentLayoutAccess ()
const IDocumentLinksAdministrationgetIDocumentLinksAdministration () const
 Provides access to the document links administration interface. More...
IDocumentLinksAdministrationgetIDocumentLinksAdministration ()
const IDocumentFieldsAccessgetIDocumentFieldsAccess () const
 Provides access to the document fields administration interface. More...
IDocumentFieldsAccessgetIDocumentFieldsAccess ()
IDocumentContentOperationsgetIDocumentContentOperations ()
 Provides access to the document content operations interface. More...
IStyleAccessgetIDocumentStyleAccess ()
 Provides access to the document automatic styles interface. More...
IDocumentListItemsgetIDocumentListItems ()
 Provides access to the document's numbered items interface. More...
bool IsInVisibleArea (SwViewShell const *pSh) const
 Is node in the visible area of the Shell? More...
bool IsInProtectSect () const
 Is node in a protected area? More...
bool IsProtect () const
 Is node in something that is protected (range, frame, table cells ... including anchor in case of frames or footnotes)? More...
const SwPageDescFindPageDesc (SwNodeOffset *pPgDescNdIdx=nullptr) const
 Search PageDesc with which this node is formatted. More...
SwFrameFormatGetFlyFormat () const
 If node is in a fly return the respective format. More...
SwTableBoxGetTableBox () const
 If node is in a table return the respective table box. More...
SwNodeOffset GetIndex () const
const SwTextNodeFindOutlineNodeOfLevel (sal_uInt8 nLvl, SwRootFrame const *pLayout=nullptr) const
sal_uInt8 HasPrevNextLayNode () const
std::vector< SwFrameFormat * > const & GetAnchoredFlys () const
void AddAnchoredFly (SwFrameFormat *)
void RemoveAnchoredFly (SwFrameFormat *)
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 Dumps the node structure to the given destination (file nodes.xml in the current directory by default) More...
bool operator== (const SwNode &rOther) const
bool operator!= (const SwNode &rOther) const
bool operator< (const SwNode &rOther) const
bool operator<= (const SwNode &rOther) const
bool operator> (const SwNode &rOther) const
bool operator>= (const SwNode &rOther) const
sw::AccessibilityCheckStatusgetAccessibilityCheckStatus ()
void resetAndQueueAccessibilityCheck ()
- Public Member Functions inherited from sw::BorderCacheOwner
 BorderCacheOwner ()
 BorderCacheOwner (BorderCacheOwner &)
BorderCacheOwneroperator= (const BorderCacheOwner &)
 ~BorderCacheOwner ()
bool IsInCache () const
void InvalidateInSwCache (const sal_uInt16)

Private Member Functions

 SwSectionNode (const SwSectionNode &)=delete
SwSectionNodeoperator= (const SwSectionNode &)=delete
virtual ~SwSectionNode () override

Private Attributes

std::unique_ptr< SwSection > const m_pSection


class SwNodes

Additional Inherited Members

- Public Types inherited from SwNode
enum class  Merge {
  None ,
  First ,
  NonFirst ,
 sw_redlinehide: redline node merge state More...
- Protected Member Functions inherited from SwStartNode
 SwStartNode (const SwNode &rWhere, const SwNodeType nNodeType=SwNodeType::Start, SwStartNodeType=SwNormalStartNode)
- Protected Member Functions inherited from SwNode
 SwNode ()
 only used by SwContentNodeTmp in SwTextNode::Update More...
 SwNode (const SwNode &rWhere, const SwNodeType nNodeId)
 SwNode (SwNodes &rNodes, SwNodeOffset nPos, const SwNodeType nNodeId)
 for the initial StartNode More...
- Protected Attributes inherited from SwNode

Detailed Description

A section node represents the start of a section on the UI, i.e.

the container created using Insert -> Section menu item.

Definition at line 573 of file node.hxx.

Constructor & Destructor Documentation

◆ SwSectionNode() [1/2]

SwSectionNode::SwSectionNode ( const SwSectionNode )

Referenced by MakeCopy().

◆ ~SwSectionNode()

SwSectionNode::~SwSectionNode ( )

Definition at line 1009 of file ndsect.cxx.

References m_pSection, RES_CNTNT(), and SwFormat::ResetFormatAttr().

◆ SwSectionNode() [2/2]

SwSectionNode::SwSectionNode ( const SwNode rWhere,
SwSectionFormat rFormat,
SwTOXBase const *const  pTOXBase 

Definition at line 994 of file ndsect.cxx.

References Content, GetName(), and SwFormat::SetFormatAttr().

Member Function Documentation

◆ DelFrames()

void SwSectionNode::DelFrames ( SwRootFrame const *  pLayout = nullptr,
bool  bForce = false 

Method deletes all views of document for the node.

The content frames are removed from the respective layout.

Definition at line 1175 of file ndsect.cxx.

References CheckNodesRange(), SwNode::EndOfSectionIndex(), SwNode::EndOfSectionNode(), SwNode::GetIndex(), SwNodeIndex::GetNode(), SwNode::GetNodes(), SwNodes::GoNextSection(), SwNodes::GoPrevSection(), lcl_IsInSameTableBox(), and m_pSection.

Referenced by MakeCopy(), and SwNodes::MoveNodes().

◆ dumpAsXml()

void SwSectionNode::dumpAsXml ( xmlTextWriterPtr  pWriter) const

Dumps the node structure to the given destination (file nodes.xml in the current directory by default)

Reimplemented from SwStartNode.

Definition at line 1315 of file ndsect.cxx.

References SwNode::GetIndex(), SwNode::GetNodeType(), and m_pSection.

◆ GetSection() [1/2]

SwSection & SwSectionNode::GetSection ( )

Definition at line 591 of file node.hxx.

◆ GetSection() [2/2]

const SwSection & SwSectionNode::GetSection ( ) const

Definition at line 590 of file node.hxx.

Referenced by SwNodes::CopyNodes(), SwTextShell::ExecIdx(), SwEnhancedPDFExportHelper::ExportAuthorityEntryLinks(), RtfExport::ExportDocument_Impl(), SwNode::FindPageDesc(), SwNodes::FindPrvNxtFrameNode(), SwUpdFootnoteEndNtAtEnd::FindSectNdWithEndAttr(), SwCursorShell::FindValidContentNode(), SwDoc::GetCurrSection(), SwDoc::GetCurTOX(), SwSectionFormat::GetGlobalDocSection(), SwTextShell::GetIdxState(), GetNode(), SwUpdFootnoteEndNtAtEnd::GetNumber(), SwXRedline::getPropertyValue(), SwXCell::getPropertyValue(), SwXTextTable::getPropertyValue(), MSWordExportBase::GetSectionFormat(), GetTOX(), SwDoc::GetUniqueSectionName(), SwDoc::GetUniqueTOXBaseName(), SwFormatFootnote::GetViewNumStr(), SwAutoFormat::GoNextPara(), SwNodes::GoNextSection(), SwNodes::GoPrevSection(), GotoCurrRegionAndSkip(), GotoNextRegion(), GotoPrevRegion(), SwXTextCursor::gotoStart(), SwPaM::HasReadonlySel(), InsertCnt_(), SwDoc::InsertSwSection(), SwDoc::InsertTableOf(), SwNodes::InsertTextSection(), SwCursor::IsAtValidPos(), IsContentHidden(), SwTextNode::IsHidden(), SwOLENode::IsInGlobalDocSection(), SwNode::IsInProtectSect(), SwWrtShell::IsOutlineContentVisible(), SwCursor::IsSelOvr(), SwTOXBase::IsTOXBaseInReadonly(), lcl_BreakSectionLinksInSect(), lcl_CheckHiddenSection(), lcl_html_IsMultiColStart(), lcl_initParent(), lcl_IsAtTextEnd(), lcl_IsInSameTableBox(), SwSection::MakeChildLinksVisible(), MakeCopy(), SwDocUpdateField::MakeFieldList_(), MakeFramesForAdjacentContentNode(), SwNodes::MakeTextNode(), MSWordSections::MSWordSections(), NodesArrChgd(), SwHTMLWriter::Out_SwDoc(), OutHTML_Section(), DocxExport::OutputEndNode(), MSWordExportBase::OutputSectionNode(), MSWordExportBase::OutputTextNode(), SwUndoDelSection::RedoImpl(), SwNodes::RemoveNode(), SetGetExpField::SetGetExpField(), SwEditShell::SetSectionAttr(), SwCursorShell::SetVisibleCursor(), SwDoc::SplitDoc(), SwNodes::TableToText(), SwUndoUpdateIndex::TitleSectionInserted(), SwUndoInsSection::UndoImpl(), SwUndoDelSection::UndoImpl(), UnHideRedlinesExtras(), SwTOXBaseSection::Update(), SwCursorShell::UpdateCursor(), MSWordExportBase::UpdateTocSectionNodeProperties(), SwHTMLWriter::WriteStream(), MSWordExportBase::WriteText(), and SwSectionFormat::~SwSectionFormat().

◆ IsContentHidden()

bool SwSectionNode::IsContentHidden ( ) const

◆ MakeCopy()

SwSectionNode * SwSectionNode::MakeCopy ( SwDoc rDoc,
const SwNodeIndex rIdx 
) const

◆ MakeFrame()

SwFrame * SwSectionNode::MakeFrame ( SwFrame pSib)

Definition at line 1025 of file ndsect.cxx.

References m_pSection.

Referenced by InsertCnt_().

◆ MakeFramesForAdjacentContentNode()

void SwSectionNode::MakeFramesForAdjacentContentNode ( const SwNodeIndex rIdx)

◆ MakeOwnFrames()

void SwSectionNode::MakeOwnFrames ( SwNodeIndex pIdxBehind,
SwNodeIndex pEnd = nullptr 

Creates the frms for the SectionNode (i.e.

the SectionFrames). On default the frames are created until the end of the range. When another NodeIndex pEnd is passed a MakeFrames is called up to it. Used by TableToText.

Definition at line 1156 of file ndsect.cxx.

References SwNode::EndOfSectionNode(), SwNodes::GetDoc(), SwNodeIndex::GetNode(), GetNode(), SwNode::GetNodes(), SwNodes::IsDocNodes(), m_pSection, and MakeFrames().

Referenced by SwNodes::CopyNodes(), SwNodes::InsertTextSection(), SwSectionFormat::MakeFrames(), SwNodes::MoveNodes(), and SwNodes::TableToText().

◆ NodesArrChgd()

void SwSectionNode::NodesArrChgd ( )

◆ operator=()

SwSectionNode & SwSectionNode::operator= ( const SwSectionNode )

Friends And Related Function Documentation

◆ SwNodes

friend class SwNodes

Definition at line 576 of file node.hxx.

Member Data Documentation

◆ m_pSection

std::unique_ptr<SwSection> const SwSectionNode::m_pSection

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