svx/source/cui/iconcdlg.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: iconcdlg.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _ICCDLG_HXX
  31 #define _ICCDLG_HXX
  32
  33 #include <vcl/tabpage.hxx>
  34 #include <vcl/msgbox.hxx>
  35 #include <vcl/dialog.hxx>
  36 #ifndef _SV_BUTTON_HXX
  37 #include <vcl/button.hxx>
  38 #endif
  39 #include <vcl/image.hxx>
  40 #include <svtools/ivctrl.hxx>
  41 #include <svtools/itempool.hxx>
  42 #include <svtools/itemset.hxx>
  43 #include <tools/list.hxx>
  44 #include <tools/string.hxx>
  45
  46 #define CTRLS_OFFSET            3
  47 #define BUTTON_DISTANCE         8
  48 #define RET_USER                100
  49 #define RET_USER_CANCEL 101
  50
  51 // forward-declarations
  52 struct IconChoicePageData;
  53 class IconChoiceDialog;
  54 class IconChoicePage;
  55
  56 // Create-Function
  57 typedef IconChoicePage* (*CreatePage)(Window *pParent, const SfxItemSet &rAttrSet);
  58 typedef USHORT*             (*GetPageRanges)(); // liefert internationale Which-Wert
  59
  60 // page-list
  61 DECLARE_LIST( IconChoicePageList, IconChoicePageData * )
  62
  63 // position of iconchoicectrl
  64 enum EIconChoicePos { PosLeft, PosRight, PosTop, PosBottom };
  65
  66 /**********************************************************************
  67 |
  68 | Data-structure for pages in dialog
  69 |
  70 \**********************************************************************/
  71
  72 struct IconChoicePageData
  73 {
  74     USHORT nId;                                  // Die ID
  75     CreatePage fnCreatePage;     // Pointer auf die Factory
  76     GetPageRanges fnGetRanges;// Pointer auf die Ranges-Funktion
  77     IconChoicePage* pPage;               // die TabPage selber
  78     BOOL bOnDemand;                              // Flag: ItemSet onDemand
  79     BOOL bRefresh;                               // Flag: Seite mu\s neu initialisiert werden
  80
  81     // Konstruktor
  82     IconChoicePageData( USHORT Id, CreatePage fnPage, GetPageRanges fnRanges, BOOL bDemand )
  83         : nId                   ( Id ),
  84           fnCreatePage  ( fnPage ),
  85           fnGetRanges   ( fnRanges ),
  86           pPage                 ( NULL ),
  87           bOnDemand             ( bDemand ),
  88           bRefresh              ( FALSE )
  89     {}
  90 };
  91
  92 /**********************************************************************
  93 |
  94 | IconChoicePage
  95 |
  96 \**********************************************************************/
  97
  98 class IconChoicePage : public TabPage
  99 {
 100     using TabPage::ActivatePage;
 101     using TabPage::DeactivatePage;
 102
 103 private :
 104     const SfxItemSet*   pSet;
 105     String                              aUserString;
 106     BOOL                                bHasExchangeSupport;
 107     IconChoiceDialog*   pDialog;
 108     BOOL                                bStandard;
 109
 110     void                                SetDialog( IconChoiceDialog* pNew ) { pDialog = pNew; }
 111     IconChoiceDialog*   GetDialog() const { return pDialog; }
 112
 113     void                                SetInputSet( const SfxItemSet* pNew ) { pSet = pNew; }
 114
 115     void                                ImplInitSettings();
 116
 117 protected :
 118     IconChoicePage( Window *pParent, const ResId &, const SfxItemSet &rAttrSet );
 119
 120     USHORT                              GetSlot( USHORT nWhich ) const  { return pSet->GetPool()->GetSlotId( nWhich ); }
 121     USHORT                              GetWhich( USHORT nSlot ) const  { return pSet->GetPool()->GetWhich( nSlot ); }
 122     const SfxPoolItem*  GetOldItem( const SfxItemSet& rSet, USHORT nSlot );
 123     const SfxPoolItem*  GetExchangeItem( const SfxItemSet& rSet, USHORT nSlot );
 124
 125 public :
 126     virtual             ~IconChoicePage();
 127
 128     const SfxItemSet&   GetItemSet() const { return *pSet; }
 129
 130     virtual BOOL                FillItemSet( SfxItemSet& ) = 0;
 131     virtual void                Reset( const SfxItemSet& ) = 0;
 132
 133     BOOL                                HasExchangeSupport() const                              { return bHasExchangeSupport; }
 134     void                                SetExchangeSupport( BOOL bNew = TRUE )  { bHasExchangeSupport = bNew; }
 135
 136     enum {
 137         KEEP_PAGE = 0x0000,             // Fehlerbehandlung; Seite nicht wechseln
 138             // 2. F"ullen eines ItemSets f"ur die Aktualilsierung
 139             // "ubergeordneter Beispiele; dieser Pointer kann immer
 140             // NULL sein!!
 141         LEAVE_PAGE = 0x0001,
 142             // Set aktualisieren und andere Page aktualisieren
 143         REFRESH_SET = 0x0002
 144     };
 145
 146     virtual void                ActivatePage( const SfxItemSet& );
 147     virtual int                 DeactivatePage( SfxItemSet* pSet = 0 );
 148     void                                SetUserData(const String& rString)      { aUserString = rString; }
 149     String                              GetUserData() { return aUserString; }
 150     virtual void                FillUserData();
 151     virtual BOOL                IsReadOnly() const;
 152     virtual sal_Bool    QueryClose();
 153
 154     static const SfxPoolItem* GetItem( const SfxItemSet& rSet, USHORT nSlot );
 155
 156     void                                StateChanged( StateChangedType nType );
 157     void                                DataChanged( const DataChangedEvent& rDCEvt );
 158 };
 159
 160 /**********************************************************************
 161 |
 162 | IconChoiceDialog
 163 |
 164 \**********************************************************************/
 165
 166 class IconChoiceDialog : public ModalDialog
 167 {
 168 private :
 169     friend class IconChoicePage;
 170
 171     EIconChoicePos                      meChoicePos;    // Position des IconChoiceCtrl's
 172     IconChoicePageList          maPageList;             // Liste von PageData-Pointer
 173
 174     SvtIconChoiceCtrl           maIconCtrl;             // DAS IconChoice-Control
 175
 176     USHORT                                      mnCurrentPageId;        // Id der aktuell sichtbaren Page
 177
 178     // Buttons
 179     OKButton                            aOKBtn;
 180     CancelButton                        aCancelBtn;
 181     HelpButton                          aHelpBtn;
 182     PushButton                          aResetBtn;
 183
 184     const SfxItemSet*           pSet;
 185     SfxItemSet*                         pOutSet;
 186     SfxItemSet*                         pExampleSet;
 187     USHORT*                                     pRanges;
 188
 189     sal_uInt32                          nResId;
 190
 191     BOOL                                        bHideResetBtn;
 192     BOOL                                        bModal;
 193     BOOL                                        bInOK;
 194     BOOL                                        bModified;
 195     BOOL                                        bItemsReset;
 196
 197     DECL_LINK ( ChosePageHdl_Impl, void * );
 198     DECL_LINK ( OkHdl,                     Button * );
 199     DECL_LINK ( ResetHdl,          Button * );
 200     DECL_LINK ( CancelHdl,                 Button * );
 201
 202     IconChoicePageData*         GetPageData ( USHORT nId );
 203     void                                        Start_Impl();
 204     BOOL                                        OK_Impl();
 205
 206     void                                        SetPosSizeCtrls ( BOOL bInit = FALSE );
 207     void                                        SetPosSizePages ( USHORT nId );
 208
 209     void                                        FocusOnIcon ( USHORT nId );
 210
 211 protected :
 212     void                                        ShowPageImpl ( IconChoicePageData* pData );
 213     void                                        HidePageImpl ( IconChoicePageData* pData );
 214
 215     virtual void            PageCreated( USHORT nId, IconChoicePage& rPage );
 216     virtual SfxItemSet*         CreateInputItemSet( USHORT nId );
 217     inline SfxItemSet*          GetInputSetImpl() { return (SfxItemSet*)pSet; }
 218     inline IconChoicePage*      GetTabPage( USHORT nPageId )
 219                                 { return ( GetPageData (nPageId)->pPage?GetPageData (nPageId)->pPage:NULL); }
 220     const SfxItemSet*           GetRefreshedSet();
 221
 222     void                                        ActivatePageImpl ();
 223     BOOL                                        DeActivatePageImpl ();
 224     void                                        ResetPageImpl ();
 225
 226     short                                       Ok();
 227     BOOL                                        IsInOK() const;
 228
 229 public :
 230
 231     // im Ctor könnte auch die Position des IconChoiceCtrl's gesetzt werden.
 232
 233     IconChoiceDialog ( Window* pParent, const ResId &rResId,
 234                        const EIconChoicePos ePos = PosLeft, const SfxItemSet * pItemSet = 0 );
 235     ~IconChoiceDialog ();
 236
 237     ///////////////////////////////////////////////////////////////////////////////////
 238     // virtuelle Methoden
 239     //
 240     virtual void                Paint( const Rectangle& rRect );
 241     virtual void                Resize();
 242
 243     ///////////////////////////////////////////////////////////////////////////////////
 244     // Schnittstelle
 245     //
 246
 247     SvxIconChoiceCtrlEntry*     AddTabPage(
 248         USHORT nId, const String& rIconText, const Image& rChoiceIcon,
 249         CreatePage pCreateFunc /* != NULL */, GetPageRanges pRangesFunc = NULL /* NULL allowed*/,
 250         BOOL bItemsOnDemand = FALSE, ULONG nPos = LIST_APPEND );
 251
 252     SvxIconChoiceCtrlEntry*     AddTabPage(
 253         USHORT nId, const String& rIconText, const Image& rChoiceIcon, const Image& rChoiceIconHC,
 254         CreatePage pCreateFunc /* != NULL */, GetPageRanges pRangesFunc = NULL /* NULL allowed*/,
 255         BOOL bItemsOnDemand = FALSE, ULONG nPos = LIST_APPEND );
 256
 257     void                                RemoveTabPage( USHORT nId );
 258
 259     void                                SetCurPageId( USHORT nId ) { mnCurrentPageId = nId; FocusOnIcon( nId ); }
 260     USHORT                              GetCurPageId() const       { return mnCurrentPageId; }
 261     void                                ShowPage( USHORT nId );
 262
 263                         // liefert ggf. per Map konvertierte lokale Slots
 264     const USHORT*               GetInputRanges( const SfxItemPool& );
 265     void                                SetInputSet( const SfxItemSet* pInSet );
 266     const SfxItemSet*   GetOutputItemSet() const { return pOutSet; }
 267     const SfxItemSet*   GetOutputItemSet( USHORT nId );
 268     int                                 FillOutputItemSet();
 269
 270     const OKButton&     GetOKButton() const { return aOKBtn; }
 271     OKButton&                   GetOKButton() { return aOKBtn; }
 272     const CancelButton& GetCancelButton() const { return aCancelBtn; }
 273     CancelButton&               GetCancelButton() { return aCancelBtn; }
 274     const HelpButton&   GetHelpButton() const { return aHelpBtn; }
 275     HelpButton&                 GetHelpButton() { return aHelpBtn; }
 276
 277     void                                RemoveResetButton();
 278
 279     short                               Execute();
 280     void                                Start( BOOL bShow = TRUE );
 281     sal_Bool            QueryClose();
 282
 283     const SfxItemSet*   GetExampleSet() const { return pExampleSet; }
 284
 285     void                                SetCtrlColor ( const Color& rColor );
 286     EIconChoicePos              SetCtrlPos   ( const EIconChoicePos& rPos );
 287
 288     void                                CreateIconTextAutoMnemonics( void );
 289 };
 290
 291 #endif //_ICCDLG_HXX
 292