diff options
Diffstat (limited to 'sc/inc/scextopt.hxx')
| -rw-r--r-- | sc/inc/scextopt.hxx | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/sc/inc/scextopt.hxx b/sc/inc/scextopt.hxx index 22e6ab6fb9a0..33e5a268b693 100644 --- a/sc/inc/scextopt.hxx +++ b/sc/inc/scextopt.hxx @@ -28,10 +28,10 @@ /** Extended settings for the document, used in import/export filters. */ struct ScExtDocSettings { - String maGlobCodeName; /// Global codename (VBA module name). - double mfTabBarWidth; /// Width of the tabbar, relative to frame window width (0.0 ... 1.0). - sal_uInt32 mnLinkCnt; /// Recursive counter for loading external documents. - SCTAB mnDisplTab; /// Index of displayed sheet. + String maGlobCodeName; ///< Global codename (VBA module name). + double mfTabBarWidth; ///< Width of the tabbar, relative to frame window width (0.0 ... 1.0). + sal_uInt32 mnLinkCnt; ///< Recursive counter for loading external documents. + SCTAB mnDisplTab; ///< Index of displayed sheet. explicit ScExtDocSettings(); }; @@ -39,30 +39,30 @@ struct ScExtDocSettings /** Enumerates possible positions of panes in split sheets. */ enum ScExtPanePos { - SCEXT_PANE_TOPLEFT, /// Single, top, left, or top-left pane. - SCEXT_PANE_TOPRIGHT, /// Right, or top-right pane. - SCEXT_PANE_BOTTOMLEFT, /// Bottom, or bottom-left pane. - SCEXT_PANE_BOTTOMRIGHT /// Bottom-right pane. + SCEXT_PANE_TOPLEFT, ///< Single, top, left, or top-left pane. + SCEXT_PANE_TOPRIGHT, ///< Right, or top-right pane. + SCEXT_PANE_BOTTOMLEFT, ///< Bottom, or bottom-left pane. + SCEXT_PANE_BOTTOMRIGHT ///< Bottom-right pane. }; /** Extended settings for a sheet, used in import/export filters. */ struct ScExtTabSettings { - ScRange maUsedArea; /// Used area in the sheet (columns/rows only). - ScRangeList maSelection; /// Selected cell ranges (columns/rows only). - ScAddress maCursor; /// The cursor position (column/row only). - ScAddress maFirstVis; /// Top-left visible cell (column/row only). - ScAddress maSecondVis; /// Top-left visible cell in add. panes (column/row only). - ScAddress maFreezePos; /// Position of frozen panes (column/row only). - Point maSplitPos; /// Position of split. - ScExtPanePos meActivePane; /// Active (focused) pane. - Color maGridColor; /// Grid color. - long mnNormalZoom; /// Zoom in percent for normal view. - long mnPageZoom; /// Zoom in percent for pagebreak preview. - bool mbSelected; /// true = Sheet is selected. - bool mbFrozenPanes; /// true = Frozen panes; false = Normal splits. - bool mbPageMode; /// true = Pagebreak mode; false = Normal view mode. - bool mbShowGrid; /// Whether or not to display gridlines. + ScRange maUsedArea; ///< Used area in the sheet (columns/rows only). + ScRangeList maSelection; ///< Selected cell ranges (columns/rows only). + ScAddress maCursor; ///< The cursor position (column/row only). + ScAddress maFirstVis; ///< Top-left visible cell (column/row only). + ScAddress maSecondVis; ///< Top-left visible cell in add. panes (column/row only). + ScAddress maFreezePos; ///< Position of frozen panes (column/row only). + Point maSplitPos; ///< Position of split. + ScExtPanePos meActivePane; ///< Active (focused) pane. + Color maGridColor; ///< Grid color. + long mnNormalZoom; ///< Zoom in percent for normal view. + long mnPageZoom; ///< Zoom in percent for pagebreak preview. + bool mbSelected; ///< true = Sheet is selected. + bool mbFrozenPanes; ///< true = Frozen panes; false = Normal splits. + bool mbPageMode; ///< true = Pagebreak mode; false = Normal view mode. + bool mbShowGrid; ///< Whether or not to display gridlines. explicit ScExtTabSettings(); }; @@ -84,24 +84,24 @@ public: ScExtDocOptions& operator=( const ScExtDocOptions& rSrc ); - /** Returns true, if the data needs to be copied to the view data after import. */ + /** @return true, if the data needs to be copied to the view data after import. */ bool IsChanged() const; /** If set to true, the data will be copied to the view data after import. */ void SetChanged( bool bChanged ); - /** Returns read access to the global document settings. */ + /** @return read access to the global document settings. */ const ScExtDocSettings& GetDocSettings() const; - /** Returns read/write access to the global document settings. */ + /** @return read/write access to the global document settings. */ ScExtDocSettings& GetDocSettings(); - /** Returns read access to the settings of a sheet, if extant; otherwise 0. */ + /** @return read access to the settings of a sheet, if extant; otherwise 0. */ const ScExtTabSettings* GetTabSettings( SCTAB nTab ) const; - /** Returns read/write access to the settings of a sheet, may create a new struct. */ + /** @return read/write access to the settings of a sheet, may create a new struct. */ ScExtTabSettings& GetOrCreateTabSettings( SCTAB nTab ); - /** Returns the number of sheet codenames. */ + /** @return the number of sheet codenames. */ SCTAB GetCodeNameCount() const; - /** Returns the specified codename (empty string = no codename). */ + /** @return the specified codename (empty string = no codename). */ const String& GetCodeName( SCTAB nTab ) const; /** Appends a codename for a sheet. */ void SetCodeName( SCTAB nTab, const String& rCodeName ); |