A note object, which is a specialized text box object. More...
#include <xiescher.hxx>
Inheritance diagram for XclImpNoteObj:
Collaboration diagram for XclImpNoteObj:
Public Member Functions | |
| XclImpNoteObj (const XclImpRoot &rRoot) | |
| void | SetNoteData (const ScAddress &rScPos, sal_uInt16 nNoteFlags) |
| Sets note flags and the note position in the Calc sheet. More... | |
 Public Member Functions inherited from XclImpTextObj | |
| XclImpTextObj (const XclImpRoot &rRoot) | |
| void | SetTextData (const XclImpObjTextData &rTextData) |
| Stores the passed textbox data. More... | |
| Public Member Functions inherited from XclImpRectObj | |
| XclImpRectObj (const XclImpRoot &rRoot) | |
| Public Member Functions inherited from XclImpDrawObjBase | |
| XclImpDrawObjBase (const XclImpRoot &rRoot) | |
| virtual | ~XclImpDrawObjBase () override |
| void | SetAreaObj (bool bAreaObj) |
| Sets whether this is an area object (then its width and height must be greater than 0). More... | |
| void | SetSimpleMacro (bool bMacro) |
| If set to true, a new SdrObject will be created while in DFF import. More... | |
| void | SetAnchor (const XclObjAnchor &rAnchor) |
| Sets the object anchor explicitly. More... | |
| void | SetDffData (const DffObjData &rDffObjData, const OUString &rObjName, const OUString &rHyperlink, bool bVisible, bool bAutoMargin) |
| Sets shape data from DFF stream. More... | |
| void | SetProcessSdrObj (bool bProcess) |
| If set to false, the SdrObject will not be created, processed, or inserted into the draw page. More... | |
| void | SetInsertSdrObj (bool bInsert) |
| If set to false, the SdrObject will be created or processed, but not be inserted into the draw page. More... | |
| void | SetCustomDffObj (bool bCustom) |
| If set to true, a new SdrObject will be created while in DFF import. More... | |
| sal_uInt16 | GetObjId () const |
| Returns the sheet index and Excel object identifier from OBJ record. More... | |
| sal_uInt16 | GetObjType () const |
| Returns the Excel object type from OBJ record. More... | |
| virtual OUString | GetObjName () const |
| Returns the name of this object, may generate a default name. More... | |
| const OUString & | GetMacroName () const |
| Returns associated macro name, if set, otherwise zero length string. More... | |
| sal_uInt32 | GetDffShapeId () const |
| Returns the shape identifier used in the DFF stream. More... | |
| ShapeFlag | GetDffFlags () const |
| Returns the shape flags from the DFF stream. More... | |
| const tools::Rectangle & | GetDffRect () const |
| bool | IsHidden () const |
| Returns true, if the object is hidden. More... | |
| bool | IsVisible () const |
| Returns true, if the object is visible. More... | |
| bool | IsPrintable () const |
| Returns true, if the object is printable. More... | |
| const XclObjAnchor * | GetAnchor () const |
| Returns the object anchor if existing, null otherwise. More... | |
| bool | IsValidSize (const tools::Rectangle &rAnchorRect) const |
| Returns true, if the passed size is valid for this object. More... | |
| ScRange | GetUsedArea (SCTAB nScTab) const |
| Returns the range in the sheet covered by this object. More... | |
| bool | IsProcessSdrObj () const |
| Returns true, if the object is valid and will be processed. More... | |
| bool | IsInsertSdrObj () const |
| Returns true, if the SdrObject will be created or processed, but not be inserted into the draw page. More... | |
| std::size_t | GetProgressSize () const |
| Returns the needed size on the progress bar (calls virtual DoGetProgressSize() function). More... | |
| rtl::Reference< SdrObject > | CreateSdrObject (XclImpDffConverter &rDffConv, const tools::Rectangle &rAnchorRect, bool bIsDff) const |
| Creates and returns an SdrObject from the contained data. More... | |
| void | PreProcessSdrObject (XclImpDffConverter &rDffConv, SdrObject &rSdrObj) |
| Additional processing for the passed SdrObject before insertion into the drawing page (calls virtual DoPreProcessSdrObj() function). More... | |
| void | PostProcessSdrObject (XclImpDffConverter &rDffConv, SdrObject &rSdrObj) const |
| Additional processing for the passed SdrObject after insertion into the drawing page (calls virtual DoPostProcessSdrObj() function). More... | |
| SCTAB | GetTab () const |
Protected Member Functions | |
| virtual void | DoPreProcessSdrObj (XclImpDffConverter &rDffConv, SdrObject &rSdrObj) const override |
| Inserts the note into the document, sets visibility. More... | |
| Protected Member Functions inherited from XclImpTextObj | |
| virtual void | DoReadObj3 (XclImpStream &rStrm, sal_uInt16 nMacroSize) override |
| Reads the contents of the a BIFF3 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj4 (XclImpStream &rStrm, sal_uInt16 nMacroSize) override |
| Reads the contents of the a BIFF4 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj5 (XclImpStream &rStrm, sal_uInt16 nNameLen, sal_uInt16 nMacroSize) override |
| Reads the contents of the a BIFF5 OBJ record from the passed stream. More... | |
| virtual rtl::Reference< SdrObject > | DoCreateSdrObj (XclImpDffConverter &rDffConv, const tools::Rectangle &rAnchorRect) const override |
| Creates and returns a new SdrObject from the contained data. More... | |
| virtual void | DoPreProcessSdrObj (XclImpDffConverter &rDffConv, SdrObject &rSdrObj) const override |
| Inserts the contained text data at the passed object. More... | |
| Protected Member Functions inherited from XclImpRectObj | |
| void | ReadFrameData (XclImpStream &rStrm) |
| Reads fil data, line data, and frame flags. More... | |
| void | ConvertRectStyle (SdrObject &rSdrObj) const |
| Converts fill formatting, line formatting, and frame style. More... | |
| virtual void | DoReadObj3 (XclImpStream &rStrm, sal_uInt16 nMacroSize) override |
| Reads the contents of the a BIFF3 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj4 (XclImpStream &rStrm, sal_uInt16 nMacroSize) override |
| Reads the contents of the a BIFF4 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj5 (XclImpStream &rStrm, sal_uInt16 nNameLen, sal_uInt16 nMacroSize) override |
| Reads the contents of the a BIFF5 OBJ record from the passed stream. More... | |
| virtual rtl::Reference< SdrObject > | DoCreateSdrObj (XclImpDffConverter &rDffConv, const tools::Rectangle &rAnchorRect) const override |
| Creates and returns a new SdrObject from the contained data. More... | |
| Protected Member Functions inherited from XclImpDrawObjBase | |
| void | ReadName5 (XclImpStream &rStrm, sal_uInt16 nNameLen) |
| Reads the object name in a BIFF5 OBJ record. More... | |
| void | ReadMacro3 (XclImpStream &rStrm, sal_uInt16 nMacroSize) |
| Reads the macro link in a BIFF3 OBJ record. More... | |
| void | ReadMacro4 (XclImpStream &rStrm, sal_uInt16 nMacroSize) |
| Reads the macro link in a BIFF4 OBJ record. More... | |
| void | ReadMacro5 (XclImpStream &rStrm, sal_uInt16 nMacroSize) |
| Reads the macro link in a BIFF5 OBJ record. More... | |
| void | ReadMacro8 (XclImpStream &rStrm) |
| Reads the contents of the ftMacro sub structure in an OBJ record. More... | |
| void | ConvertLineStyle (SdrObject &rSdrObj, const XclObjLineData &rLineData) const |
| Converts the passed line formatting to the passed SdrObject. More... | |
| void | ConvertFillStyle (SdrObject &rSdrObj, const XclObjFillData &rFillData) const |
| Converts the passed fill formatting to the passed SdrObject. More... | |
| void | ConvertFrameStyle (SdrObject &rSdrObj, sal_uInt16 nFrameFlags) const |
| Converts the passed frame flags to the passed SdrObject. More... | |
| Color | GetSolidLineColor (const XclObjLineData &rLineData) const |
| Returns a solid line color from the passed line data struct. More... | |
| Color | GetSolidFillColor (const XclObjFillData &rFillData) const |
| Returns a solid fill color from the passed fill data struct. More... | |
| virtual void | DoReadObj3 (XclImpStream &rStrm, sal_uInt16 nMacroSize) |
| Derived classes read the contents of the a BIFF3 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj4 (XclImpStream &rStrm, sal_uInt16 nMacroSize) |
| Derived classes read the contents of the a BIFF4 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj5 (XclImpStream &rStrm, sal_uInt16 nNameLen, sal_uInt16 nMacroSize) |
| Derived classes read the contents of the a BIFF5 OBJ record from the passed stream. More... | |
| virtual void | DoReadObj8SubRec (XclImpStream &rStrm, sal_uInt16 nSubRecId, sal_uInt16 nSubRecSize) |
| Derived classes read the contents of the specified subrecord of a BIFF8 OBJ record from stream. More... | |
| virtual std::size_t | DoGetProgressSize () const |
| Derived classes may return a progress bar size different from 1. More... | |
| virtual rtl::Reference< SdrObject > | DoCreateSdrObj (XclImpDffConverter &rDffConv, const tools::Rectangle &rAnchorRect) const |
| Derived classes create and return a new SdrObject from the contained data. More... | |
| virtual void | DoPreProcessSdrObj (XclImpDffConverter &rDffConv, SdrObject &rSdrObj) const |
| Derived classes may perform additional processing for the passed SdrObject before insertion. More... | |
| virtual void | DoPostProcessSdrObj (XclImpDffConverter &rDffConv, SdrObject &rSdrObj) const |
| Derived classes may perform additional processing for the passed SdrObject after insertion. More... | |
| void | NotifyMacroEventRead () |
| Notify that the document contains a macro event handler. More... | |
| Protected Member Functions inherited from XclImpRoot | |
| XclImpRoot (XclImpRootData &rImpRootData) | |
| const XclImpRoot & | GetRoot () const |
| Returns this root instance - for code readability in derived classes. More... | |
| XclImpRoot & | GetRoot () |
| void | SetCodePage (sal_uInt16 nCodePage) |
| Sets a code page read from a CODEPAGE record for byte string import. More... | |
| void | InitializeTable (SCTAB nScTab) |
| Is called when import filter starts importing a single sheet (all BIFF versions). More... | |
| void | FinalizeTable () |
| Is called when import filter stops importing a single sheet (all BIFF versions). More... | |
| XclImpAddressConverter & | GetAddressConverter () const |
| Returns the address converter. More... | |
| XclImpFormulaCompiler & | GetFormulaCompiler () const |
| Returns the formula converter. More... | |
| ExcelToSc & | GetOldFmlaConverter () const |
| Returns the old formula converter. More... | |
| XclImpSst & | GetSst () const |
| Returns the shared string table. More... | |
| XclImpPalette & | GetPalette () const |
| Returns the color buffer. More... | |
| XclImpFontBuffer & | GetFontBuffer () const |
| Returns the font buffer. More... | |
| XclImpNumFmtBuffer & | GetNumFmtBuffer () const |
| Returns the number format buffer. More... | |
| XclImpXFBuffer & | GetXFBuffer () const |
| Returns the cell formatting attributes buffer. More... | |
| XclImpXFRangeBuffer & | GetXFRangeBuffer () const |
| Returns the buffer of XF index ranges for a sheet. More... | |
| ScRangeListTabs & | GetPrintAreaBuffer () const |
| Returns the buffer that contains all print areas in the document. More... | |
| ScRangeListTabs & | GetTitleAreaBuffer () const |
| Returns the buffer that contains all print titles in the document. More... | |
| XclImpTabInfo & | GetTabInfo () const |
| Returns the buffer that contains the sheet creation order. More... | |
| XclImpNameManager & | GetNameManager () const |
| Returns the buffer that contains internal defined names. More... | |
| XclImpLinkManager & | GetLinkManager () const |
| Returns the link manager. More... | |
| XclImpObjectManager & | GetObjectManager () const |
| Returns the drawing object manager. More... | |
| XclImpSheetDrawing & | GetCurrSheetDrawing () const |
| Returns the drawing container of the current sheet. More... | |
| XclImpCondFormatManager & | GetCondFormatManager () const |
| Returns the conditional formatting manager. More... | |
| XclImpValidationManager & | GetValidationManager () const |
| XclImpAutoFilterBuffer & | GetFilterManager () const |
| Returns the filter manager. More... | |
| XclImpWebQueryBuffer & | GetWebQueryBuffer () const |
| Returns the web query buffer. More... | |
| XclImpPivotTableManager & | GetPivotTableManager () const |
| Returns the pivot table manager. More... | |
| XclImpSheetProtectBuffer & | GetSheetProtectBuffer () const |
| Returns the sheet protection options of the current sheet. More... | |
| XclImpDocProtectBuffer & | GetDocProtectBuffer () const |
| Returns the document protection options. More... | |
| XclImpPageSettings & | GetPageSettings () const |
| Returns the page settings of the current sheet. More... | |
| XclImpDocViewSettings & | GetDocViewSettings () const |
| Returns the view settings of the entire document. More... | |
| XclImpTabViewSettings & | GetTabViewSettings () const |
| Returns the view settings of the current sheet. More... | |
| bool | HasBasic () const |
| Returns true, if the document contains a VB project. More... | |
| void | SetHasBasic () |
| Called to indicate that the document contains a VB project. More... | |
| void | ReadCodeName (XclImpStream &rStrm, bool bGlobals) |
| Reads the CODENAME record and inserts the codename into the document. More... | |
| ScDocumentImport & | GetDocImport () |
| Protected Member Functions inherited from XclRoot | |
| XclRoot (XclRootData &rRootData) | |
| XclRoot (const XclRoot &rRoot) | |
| virtual | ~XclRoot () |
| XclRoot & | operator= (const XclRoot &rRoot) |
| RootData & | GetOldRoot () const |
| Returns old RootData struct. More... | |
| XclBiff | GetBiff () const |
| Returns the current BIFF version of the importer/exporter. More... | |
| XclOutput | GetOutput () const |
| Returns the current output format of the importer/exporter. More... | |
| bool | IsImport () const |
| Returns true, if currently a document is imported. More... | |
| rtl_TextEncoding | GetTextEncoding () const |
| Returns the text encoding to import/export byte strings. More... | |
| LanguageType | GetSysLanguage () const |
| Returns the system language, i.e. More... | |
| LanguageType | GetDocLanguage () const |
| Returns the document language. More... | |
| LanguageType | GetUILanguage () const |
| Returns the UI language. More... | |
| sal_Int16 | GetDefApiScript () const |
| Returns the default script type, e.g. More... | |
| tools::Long | GetCharWidth () const |
| Returns the width of the '0' character (default font) for the current printer (twips). More... | |
| tools::Long | GetSpaceWidth () const |
| bool | IsInGlobals () const |
| Returns the current Calc sheet index. More... | |
| SCTAB | GetCurrScTab () const |
| Returns the current Calc sheet index. More... | |
| sal_Int32 | GetHmmFromPixelX (double fPixelX) const |
| Calculates the width of the passed number of pixels in 1/100 mm. More... | |
| sal_Int32 | GetHmmFromPixelY (double fPixelY) const |
| Calculates the height of the passed number of pixels in 1/100 mm. More... | |
| SfxMedium & | GetMedium () const |
| Returns the medium to import from. More... | |
| const OUString & | GetDocUrl () const |
| Returns the document URL of the imported/exported file. More... | |
| const OUString & | GetBasePath () const |
| Returns the base path of the imported/exported file. More... | |
| const OUString & | GetUserName () const |
| Returns the current user name. More... | |
| css::uno::Sequence< css::beans::NamedValue > | RequestEncryptionData (::comphelper::IDocPasswordVerifier &rVerifier) const |
| Requests and verifies a password from the medium or the user. More... | |
| const tools::SvRef< SotStorage > & | GetRootStorage () const |
| Returns the OLE2 root storage of the imported/exported file. More... | |
| bool | HasVbaStorage () const |
| Returns true, if the document contains a VBA storage. More... | |
| tools::SvRef< SotStorage > | OpenStorage (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrgName) const |
| Tries to open a storage as child of the specified storage for reading or writing. More... | |
| tools::SvRef< SotStorage > | OpenStorage (const OUString &rStrgName) const |
| Tries to open a storage as child of the root storage for reading or writing. More... | |
| tools::SvRef< SotStorageStream > | OpenStream (tools::SvRef< SotStorage > const &xStrg, const OUString &rStrmName) const |
| Tries to open a new stream in the specified storage for reading or writing. More... | |
| tools::SvRef< SotStorageStream > | OpenStream (const OUString &rStrmName) const |
| Tries to open a new stream in the root storage for reading or writing. More... | |
| ScDocument & | GetDoc () const |
| Returns reference to the destination document (import) or source document (export). More... | |
| SfxObjectShell * | GetDocShell () const |
| Returns the object shell of the Calc document. More... | |
| ScModelObj * | GetDocModelObj () const |
| Returns the object model of the Calc document. More... | |
| OutputDevice * | GetPrinter () const |
| Returns pointer to the printer of the Calc document. More... | |
| ScStyleSheetPool & | GetStyleSheetPool () const |
| Returns the style sheet pool of the Calc document. More... | |
| ScRangeName & | GetNamedRanges () const |
| Returns the defined names container of the Calc document. More... | |
| SdrPage * | GetSdrPage (SCTAB nScTab) const |
| Returns the drawing layer page of the passed sheet, if present. More... | |
| SvNumberFormatter & | GetFormatter () const |
| Returns the number formatter of the Calc document. More... | |
| DateTime | GetNullDate () const |
| Returns the null date of the current number formatter. More... | |
| sal_uInt16 | GetBaseYear () const |
| Returns the base year depending on the current null date (1900 or 1904). More... | |
| double | GetDoubleFromDateTime (const DateTime &rDateTime) const |
| Converts a date/time value to a floating-point value. More... | |
| DateTime | GetDateTimeFromDouble (double fValue) const |
| Converts a floating-point value to a date/time value. More... | |
| ScEditEngineDefaulter & | GetEditEngine () const |
| Returns the edit engine for import/export of rich strings etc. More... | |
| ScHeaderEditEngine & | GetHFEditEngine () const |
| Returns the edit engine for import/export of headers/footers. More... | |
| EditEngine & | GetDrawEditEngine () const |
| Returns the edit engine for import/export of drawing text boxes. More... | |
| XclFontPropSetHelper & | GetFontPropSetHelper () const |
| Returns the property set helper for fonts. More... | |
| XclChPropSetHelper & | GetChartPropSetHelper () const |
| Returns the property set helper for the chart filters. More... | |
| ScExtDocOptions & | GetExtDocOptions () const |
| Returns the extended document options. More... | |
| XclTracer & | GetTracer () const |
| Returns the filter tracer. More... | |
| const ScAddress & | GetScMaxPos () const |
| Returns the highest possible cell address in a Calc document. More... | |
| const ScAddress & | GetXclMaxPos () const |
| Returns the highest possible cell address in an Excel document (using current BIFF version). More... | |
| const ScAddress & | GetMaxPos () const |
| Returns the highest possible cell address valid in Calc and Excel (using current BIFF version). More... | |
| void | SetDocLanguage (LanguageType eLang) |
| Sets the document language. More... | |
| void | SetUILanguage (LanguageType eLang) |
| Sets the UI language, i.e. More... | |
| void | SetTextEncoding (rtl_TextEncoding eTextEnc) |
| Sets the text encoding to import/export byte strings. More... | |
| void | SetCharWidth (const XclFontData &rFontData) |
| Sets the width of the '0' - '9' digit character as well as the ' ' space char (using the default font) for the current printer (twips). More... | |
| void | SetCurrScTab (SCTAB nScTab) |
| Sets the current Calc sheet index. More... | |
| void | IncCurrScTab () |
| Increases the current Calc sheet index by 1. More... | |
Private Attributes | |
| ScAddress | maScPos |
| sal_uInt16 | mnNoteFlags |
| Cell position of the note object. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from XclImpDrawObjBase | |
| static XclImpDrawObjRef | ReadObj3 (const XclImpRoot &rRoot, XclImpStream &rStrm) |
| Reads the BIFF3 OBJ record, returns a new drawing object. More... | |
| static XclImpDrawObjRef | ReadObj4 (const XclImpRoot &rRoot, XclImpStream &rStrm) |
| Reads the BIFF4 OBJ record, returns a new drawing object. More... | |
| static XclImpDrawObjRef | ReadObj5 (const XclImpRoot &rRoot, XclImpStream &rStrm) |
| Reads the BIFF5 OBJ record, returns a new drawing object. More... | |
| static XclImpDrawObjRef | ReadObj8 (const XclImpRoot &rRoot, XclImpStream &rStrm) |
| Reads the BIFF8 OBJ record, returns a new drawing object. More... | |
| Static Protected Member Functions inherited from XclImpRoot | |
| static OUString | GetScAddInName (const OUString &rXclName) |
| Returns the Calc add-in function name for an Excel function name. More... | |
| Static Protected Member Functions inherited from XclRoot | |
| static OUString | GetDefaultPassword () |
| Returns the default password used for stream encryption. More... | |
| Protected Attributes inherited from XclImpTextObj | |
| XclImpObjTextData | maTextData |
| Protected Attributes inherited from XclImpRectObj | |
| XclObjFillData | maFillData |
| XclObjLineData | maLineData |
| BIFF5 fill formatting. More... | |
| sal_uInt16 | mnFrameFlags |
| BIFF5 line formatting. More... | |
Detailed Description
A note object, which is a specialized text box object.
Definition at line 441 of file xiescher.hxx.
Constructor & Destructor Documentation
◆ XclImpNoteObj()
|
explicit |
Definition at line 1852 of file xiescher.cxx.
References XclImpDrawObjBase::SetInsertSdrObj(), and XclImpDrawObjBase::SetSimpleMacro().
Member Function Documentation
◆ DoPreProcessSdrObj()
|
overrideprotectedvirtual |
Inserts the note into the document, sets visibility.
Reimplemented from XclImpTextObj.
Definition at line 1868 of file xiescher.cxx.
References SfxItemSet::CloneAsValue(), ScNoteUtil::CreateNoteFromObjectData(), XclImpTextObj::DoPreProcessSdrObj(), EXC_NOTE_VISIBLE, get_flag(), XclRoot::GetDoc(), SdrObject::GetLogicRect(), SdrObject::GetMergedItemSet(), SdrObject::GetOutlinerParaObject(), ScAddress::IsValid(), maScPos, and mnNoteFlags.
◆ SetNoteData()
| void XclImpNoteObj::SetNoteData | ( | const ScAddress & | rScPos, |
| sal_uInt16 | nNoteFlags | ||
| ) |
Sets note flags and the note position in the Calc sheet.
Definition at line 1862 of file xiescher.cxx.
References maScPos, and mnNoteFlags.
Member Data Documentation
◆ maScPos
|
private |
Definition at line 454 of file xiescher.hxx.
Referenced by DoPreProcessSdrObj(), and SetNoteData().
◆ mnNoteFlags
|
private |
Cell position of the note object.
Definition at line 455 of file xiescher.hxx.
Referenced by DoPreProcessSdrObj(), and SetNoteData().
The documentation for this class was generated from the following files:
