diff options
author | Faisal M. Al-Otaibi <fmalotaibi@kacst.edu.sa> | 2012-08-06 10:51:21 +0300 |
---|---|---|
committer | David Tardon <dtardon@redhat.com> | 2012-08-12 19:29:17 +0200 |
commit | 5a47748e4e52010dab1ef35c4ba5abe2ca304c15 (patch) | |
tree | 242f13123616a7763f330beb9850b1bab16a521d /cui/source/inc/iconcdlg.hxx | |
parent | f916abe711d154d8a5fa023b7acf5c1d12dff293 (diff) |
Modifiying some comments to follow the Doxygen standards
Change-Id: Ia64c66cfaaa9ed7b1c8f3984f797ac1605fac7d4
Diffstat (limited to 'cui/source/inc/iconcdlg.hxx')
-rw-r--r-- | cui/source/inc/iconcdlg.hxx | 48 |
1 files changed, 12 insertions, 36 deletions
diff --git a/cui/source/inc/iconcdlg.hxx b/cui/source/inc/iconcdlg.hxx index ed7079d8a2fe..7049a2b12e5a 100644 --- a/cui/source/inc/iconcdlg.hxx +++ b/cui/source/inc/iconcdlg.hxx @@ -55,20 +55,15 @@ typedef sal_uInt16* (*GetPageRanges)(); // gives international Which-val // position of iconchoicectrl enum EIconChoicePos { PosLeft, PosRight, PosTop, PosBottom }; -/********************************************************************** -| -| Data-structure for pages in dialog -| -\**********************************************************************/ - +/// Data-structure for pages in dialog struct IconChoicePageData { sal_uInt16 nId; - CreatePage fnCreatePage; // pointer to the factory - GetPageRanges fnGetRanges; // pointer to the ranges-function - IconChoicePage* pPage; // the TabPage itself - sal_Bool bOnDemand; // Flag: ItemSet onDemand - sal_Bool bRefresh; // Flag: page has to be newly initialized + CreatePage fnCreatePage; ///< pointer to the factory + GetPageRanges fnGetRanges; ///< pointer to the ranges-function + IconChoicePage* pPage; ///< the TabPage itself + sal_Bool bOnDemand; ///< Flag: ItemSet onDemand + sal_Bool bRefresh; ///< Flag: page has to be newly initialized // constructor IconChoicePageData( sal_uInt16 Id, CreatePage fnPage, GetPageRanges fnRanges, sal_Bool bDemand ) @@ -81,12 +76,6 @@ struct IconChoicePageData {} }; -/********************************************************************** -| -| IconChoicePage -| -\**********************************************************************/ - class IconChoicePage : public TabPage { using TabPage::ActivatePage; @@ -124,11 +113,11 @@ public : void SetExchangeSupport( sal_Bool bNew = sal_True ) { bHasExchangeSupport = bNew; } enum { - KEEP_PAGE = 0x0000, // error handling - // 2nd filling of an ItemSet for updating superior examples; - // this pointer can always be NULL!! + KEEP_PAGE = 0x0000, ///< error handling + /** 2nd filling of an ItemSet for updating superior examples; + this pointer can always be NULL!! */ LEAVE_PAGE = 0x0001, - // refresh set and update other pages + /// refresh set and update other pages REFRESH_SET = 0x0002 }; @@ -144,12 +133,6 @@ public : void DataChanged( const DataChangedEvent& rDCEvt ); }; -/********************************************************************** -| -| IconChoiceDialog -| -\**********************************************************************/ - class IconChoiceDialog : public ModalDialog { private : @@ -215,21 +198,14 @@ protected : public : // the IconChoiceCtrl's could also be set in the Ctor - IconChoiceDialog ( Window* pParent, const ResId &rResId, const EIconChoicePos ePos = PosLeft, const SfxItemSet * pItemSet = 0 ); ~IconChoiceDialog (); - /////////////////////////////////////////////////////////////////////////////////// - // virtual methods - // virtual void Paint( const Rectangle& rRect ); virtual void Resize(); - /////////////////////////////////////////////////////////////////////////////////// // interface - // - SvxIconChoiceCtrlEntry* AddTabPage( sal_uInt16 nId, const String& rIconText, const Image& rChoiceIcon, CreatePage pCreateFunc /* != NULL */, GetPageRanges pRangesFunc = NULL /* NULL allowed*/, @@ -239,8 +215,8 @@ public : sal_uInt16 GetCurPageId() const { return mnCurrentPageId; } void ShowPage( sal_uInt16 nId ); - // gives via map converted local slots if applicable - const sal_uInt16* GetInputRanges( const SfxItemPool& ); + /// gives via map converted local slots if applicable + const sal_uInt16* GetInputRanges( const SfxItemPool& ); void SetInputSet( const SfxItemSet* pInSet ); const SfxItemSet* GetOutputItemSet() const { return pOutSet; } |