LibreOffice Module lotuswordpro (master) 1
Public Member Functions | Private Attributes | List of all members
XFFloatFrame Class Reference

Floating frame on any page. More...

#include <xffloatframe.hxx>

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

Public Member Functions

 XFFloatFrame (sal_Int32 start, sal_Int32 end, bool all)
 @descr output range: [start,end], not [start,end). More...
 
void ToXml (IXFStream *pStrm) override
 @descr serialize. More...
 
- Public Member Functions inherited from XFFrame
 XFFrame ()
 
 XFFrame (bool isTextBox)
 
virtual ~XFFrame () override
 
virtual void Add (XFContent *pContent) override
 @descr override the add function to adjust z-index. More...
 
void SetAnchorType (enumXFAnchor type)
 @descr: Set the anchor type for the frame object. More...
 
void SetAnchorPage (sal_Int32 page)
 @descr: if it's page anchor,set the page number. More...
 
void SetName (const OUString &name)
 @descr Set frame name. More...
 
void SetZIndex (sal_uInt32 zIndex)
 @descr Set z-index of the frame. More...
 
void SetX (double x)
 @descr Set frame position X. More...
 
void SetY (double y)
 @descr Set frame position Y. More...
 
void SetWidth (double width)
 @descr Set frame width. More...
 
void SetHeight (double height)
 @descr Set frame height. More...
 
void SetMinHeight (double minHeight)
 @descr Set frame min-height. More...
 
void SetPosition (double x, double y, double width, double height)
 @descr Set frame position. More...
 
void SetPosition (const XFRect &rect)
 @descr Set frame position. More...
 
void SetNextLink (const OUString &next)
 @descr: Link the text content of the two frame. More...
 
enumXFFrameType GetFrameType () const
 @descr Get the frame type. More...
 
virtual enumXFContent GetContentType () override
 @descr Get content type, enumXFContentFrame. More...
 
virtual void ToXml (IXFStream *pStrm) override
 @descr serialize. More...
 
virtual void Add (XFContent *pContent)
 @descr Add content. More...
 
void Add (const OUString &text)
 @descr convenience function for add text content. More...
 
- Public Member Functions inherited from XFContentContainer
 XFContentContainer ()
 
virtual ~XFContentContainer () override
 @descr Destructure, all contents will be deleted too. More...
 
virtual void Add (XFContent *pContent)
 @descr Add content. More...
 
rtl::Reference< XFContentGetLastContent ()
 
void RemoveLastContent ()
 
void Add (const OUString &text)
 @descr convenience function for add text content. More...
 
int GetCount () const
 @descr return the number of contents in the container. More...
 
rtl::Reference< XFContentGetContent (sal_uInt32 index) const
 @descr get content by index. More...
 
void Reset ()
 @descr clear all contents in the container. More...
 
rtl::Reference< XFContentFindFirstContent (enumXFContent type)
 @descr helper function, find first content by type. More...
 
virtual enumXFContent GetContentType () override
 @descr return the content type. More...
 
virtual void ToXml (IXFStream *pStrm) override
 @descr Output to OOo model or local file. More...
 
bool HierarchyContains (const XFContent *pContent) const
 
- Public Member Functions inherited from XFContent
virtual enumXFContent GetContentType ()
 : return the content type. More...
 
virtual void SetStyleName (const OUString &style)
 : All content except XFTextContent can have a style. More...
 
const OUString & GetStyleName () const
 : return the style name. More...
 
void DoToXml (IXFStream *stream)
 
- Public Member Functions inherited from salhelper::SimpleReferenceObject
 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Private Attributes

sal_Int32 m_nStart
 
sal_Int32 m_nEnd
 
bool m_bAll
 

Additional Inherited Members

- Static Public Member Functions inherited from salhelper::SimpleReferenceObject
static void * operator new (std::size_t nSize)
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 
static void operator delete (void *pPtr)
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 
- Protected Member Functions inherited from XFContent
 XFContent ()
 
virtual void ToXml (IXFStream *stream)=0
 
virtual ~XFContent () override
 
- Protected Member Functions inherited from salhelper::SimpleReferenceObject
virtual ~SimpleReferenceObject () COVERITY_NOEXCEPT_FALSE
 
- Protected Attributes inherited from XFFrame
enumXFAnchor m_eAnchor
 
sal_Int32 m_nAnchorPage
 
OUString m_strName
 
sal_uInt32 m_nZIndex
 
XFRect m_aRect
 
double m_fMinHeight
 
OUString m_strNextLink
 
enumXFFrameType m_eType
 
sal_uInt32 m_nFrameFlag
 
bool m_isTextBox
 
- Protected Attributes inherited from XFContent
OUString m_strStyleName
 
- Protected Attributes inherited from salhelper::SimpleReferenceObject
oslInterlockedCount m_nCount
 

Detailed Description

Floating frame on any page.

You can specify it to be on all pages, on odd pages, or on even pages.

Definition at line 70 of file xffloatframe.hxx.

Constructor & Destructor Documentation

◆ XFFloatFrame()

XFFloatFrame::XFFloatFrame ( sal_Int32  start,
sal_Int32  end,
bool  all 
)

@descr output range: [start,end], not [start,end).

Definition at line 64 of file xffloatframe.cxx.

References end, enumXFAnchorPage, m_bAll, m_nEnd, m_nStart, XFFrame::SetAnchorType(), and start.

Member Function Documentation

◆ ToXml()

void XFFloatFrame::ToXml ( IXFStream pStrm)
overridevirtual

@descr serialize.

Reimplemented from XFFrame.

Definition at line 72 of file xffloatframe.cxx.

References IXFAttrList::Clear(), IXFStream::GetAttrList(), i, m_bAll, m_nEnd, m_nStart, XFFrame::SetAnchorPage(), and XFFrame::ToXml().

Member Data Documentation

◆ m_bAll

bool XFFloatFrame::m_bAll
private

Definition at line 84 of file xffloatframe.hxx.

Referenced by ToXml(), and XFFloatFrame().

◆ m_nEnd

sal_Int32 XFFloatFrame::m_nEnd
private

Definition at line 83 of file xffloatframe.hxx.

Referenced by ToXml(), and XFFloatFrame().

◆ m_nStart

sal_Int32 XFFloatFrame::m_nStart
private

Definition at line 82 of file xffloatframe.hxx.

Referenced by ToXml(), and XFFloatFrame().


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