sc/source/ui/inc/validate.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef SC_VALIDATE_HXX
  21 #define SC_VALIDATE_HXX
  22
  23 #include <sfx2/tabdlg.hxx>
  24 #include <vcl/edit.hxx>
  25 #include <vcl/fixed.hxx>
  26 #include <vcl/layout.hxx>
  27 #include <vcl/lstbox.hxx>
  28 #include <vcl/vclmedit.hxx>
  29 #include <svtools/svmedit.hxx>
  30
  31 #include "anyrefdg.hxx"
  32
  33 // ============================================================================
  34
  35 struct  ScRefHandlerCaller{
  36     virtual ~ScRefHandlerCaller(){}
  37 };
  38 class ScRefHandlerHelper
  39 {
  40 protected:
  41     ScRefHandlerCaller  *m_pHandler;
  42     void            (ScRefHandlerCaller::*m_pSetReferenceHdl)( const ScRange& , ScDocument* );
  43     void            (ScRefHandlerCaller::*m_pSetActiveHdl)();
  44     void            (ScRefHandlerCaller::*m_pRefInputStartPreHdl)( formula::RefEdit* pEdit, formula::RefButton* pButton );
  45     void            (ScRefHandlerCaller::*m_pRefInputStartPostHdl)( formula::RefEdit* pEdit, formula::RefButton* pButton );
  46     void            (ScRefHandlerCaller::*m_pRefInputDonePreHdl)();
  47     void            (ScRefHandlerCaller::*m_pRefInputDonePostHdl)();
  48
  49 public:
  50     typedef void            (ScRefHandlerCaller::*PFUNCSETREFHDLTYPE)( const ScRange& , ScDocument* );
  51     typedef void            (ScRefHandlerCaller::*PCOMMONHDLTYPE)();
  52     typedef void            (ScRefHandlerCaller::*PINPUTSTARTDLTYPE)(  formula::RefEdit* pEdit, formula::RefButton* pButton );
  53
  54     PFUNCSETREFHDLTYPE  SetSetRefHdl(  PFUNCSETREFHDLTYPE pNewHdl )
  55     {
  56         PFUNCSETREFHDLTYPE pOldHdl = m_pSetReferenceHdl;
  57         m_pSetReferenceHdl = pNewHdl;
  58         return pOldHdl;
  59     }
  60
  61     PCOMMONHDLTYPE  SetSetActHdl(  PCOMMONHDLTYPE pNewHdl )
  62     {
  63         PCOMMONHDLTYPE pOldHdl = m_pSetActiveHdl;
  64         m_pSetActiveHdl = pNewHdl;
  65         return pOldHdl;
  66     }
  67
  68     ScRefHandlerCaller  *SetHandler( ScRefHandlerCaller *pNewHandler )
  69     {
  70         ScRefHandlerCaller  *pOldHandler = m_pHandler;
  71         m_pHandler = pNewHandler;
  72         return pOldHandler;
  73     }
  74     void    SetRefInputStartPreHdl( PINPUTSTARTDLTYPE pNewHdl   ){  m_pRefInputStartPreHdl = pNewHdl;   }
  75     void    SetRefInputDonePostHdl( void            (ScRefHandlerCaller::*pNewHdl)()    ){  m_pRefInputDonePostHdl = pNewHdl;   }
  76     void    SetRefInputStartPostHdl(    PINPUTSTARTDLTYPE pNewHdl   ){  m_pRefInputStartPostHdl = pNewHdl;  }
  77     void    SetRefInputDonePreHdl( void            (ScRefHandlerCaller::*pNewHdl)() ){  m_pRefInputDonePreHdl = pNewHdl;    }
  78
  79     ScRefHandlerHelper():m_pHandler(NULL), m_pSetReferenceHdl( NULL ), m_pSetActiveHdl(NULL),  m_pRefInputStartPreHdl( NULL ), m_pRefInputStartPostHdl( NULL ), m_pRefInputDonePreHdl( NULL ),  m_pRefInputDonePostHdl( NULL ){}
  80 };
  81
  82 /** The "Validity" tab dialog. */
  83 class ScValidationDlg :public ScRefHdlrImpl<ScValidationDlg, SfxTabDialog, false>, public ScRefHandlerHelper
  84 {
  85     typedef ScRefHdlrImpl<ScValidationDlg, SfxTabDialog, false> ScValidationDlgBase;
  86
  87     DECL_LINK( OkHdl, Button * );
  88
  89     bool    m_bOwnRefHdlr:1;
  90
  91     ScTabViewShell *m_pTabVwSh;
  92     VclHBox* mpHBox;
  93     bool    m_bRefInputting:1;
  94     bool    EnterRefStatus();
  95     bool    LeaveRefStatus();
  96
  97 public:
  98     explicit ScValidationDlg( Window* pParent, const SfxItemSet* pArgSet, ScTabViewShell * pTabViewSh, SfxBindings *pB = NULL );
  99     virtual                     ~ScValidationDlg();
 100     inline static ScValidationDlg * Find1AliveObject( Window *pAncestor );
 101     bool    IsAlive();
 102     inline  ScTabViewShell * GetTabViewShell();
 103
 104     bool    SetupRefDlg();
 105     bool    RemoveRefDlg( sal_Bool bRestoreModal = sal_True );
 106
 107     virtual void            SetModal( sal_Bool bModal ){ ScValidationDlgBase::SetModalInputMode( bModal ); }
 108
 109     virtual void            SetReference( const ScRange& rRef, ScDocument* pDoc )
 110     {
 111         if ( m_pHandler && m_pSetReferenceHdl )
 112             (m_pHandler->*m_pSetReferenceHdl)( rRef, pDoc );
 113     }
 114
 115     virtual void            SetActive()
 116     {
 117         if ( m_pHandler && m_pSetActiveHdl )
 118             (m_pHandler->*m_pSetActiveHdl)();
 119     }
 120
 121     void        CloseRefDialog()
 122     {
 123         OSL_FAIL( "should not execute here!!!when the edit kill focus, should remove refhandler.\r\n" );
 124
 125         if ( IsInExecute() )
 126             EndDialog( false );
 127         else if ( GetStyle() & WB_CLOSEABLE )
 128             Close();
 129     }
 130
 131     bool IsRefInputting(){  return m_bRefInputting; }
 132     Window*             get_refinput_shrink_parent() { return mpHBox; }
 133
 134     virtual void        RefInputStart( formula::RefEdit* pEdit, formula::RefButton* pButton = NULL )
 135     {
 136         if( !CanInputStart( pEdit ) )
 137             return;
 138
 139         if ( m_pHandler && m_pRefInputStartPreHdl )
 140             (m_pHandler->*m_pRefInputStartPreHdl)( pEdit, pButton );
 141         m_bRefInputting = true;
 142         ScValidationDlgBase::RefInputStart( pEdit, pButton );
 143         if ( m_pHandler && m_pRefInputStartPostHdl )
 144             (m_pHandler->*m_pRefInputStartPostHdl)( pEdit, pButton );
 145     }
 146
 147     virtual void        RefInputDone( sal_Bool bForced = false )
 148     {
 149         if( !CanInputDone( bForced ) )
 150             return;
 151
 152         if ( m_pHandler && m_pRefInputDonePreHdl )
 153             (m_pHandler->*m_pRefInputDonePreHdl)();
 154
 155         ScValidationDlgBase::RefInputDone( bForced );
 156         m_bRefInputting = false;
 157
 158         if ( m_pHandler && m_pRefInputDonePostHdl )
 159             (m_pHandler->*m_pRefInputDonePostHdl)();
 160     }
 161
 162     sal_Bool IsChildFocus();
 163
 164     enum { SLOTID = SID_VALIDITY_REFERENCE };
 165
 166     sal_Bool Close();
 167 };
 168
 169
 170 // ============================================================================
 171
 172 /** The tab page "Criteria" from the Validation dialog. */
 173 class ScTPValidationValue : public ScRefHandlerCaller, public SfxTabPage
 174 {
 175 public:
 176     explicit                    ScTPValidationValue( Window* pParent, const SfxItemSet& rArgSet );
 177     virtual                     ~ScTPValidationValue();
 178
 179     static SfxTabPage*          Create( Window* pParent, const SfxItemSet& rArgSet );
 180     static sal_uInt16*              GetRanges();
 181
 182     virtual sal_Bool                FillItemSet( SfxItemSet& rArgSet );
 183     virtual void                Reset( const SfxItemSet& rArgSet );
 184
 185 private:
 186     void                        Init();
 187
 188     OUString                      GetFirstFormula() const;
 189     OUString                      GetSecondFormula() const;
 190
 191     void                        SetFirstFormula( const OUString& rFmlaStr );
 192     void                        SetSecondFormula( const OUString& rFmlaStr );
 193
 194                                 DECL_LINK(SelectHdl, void *);
 195                                 DECL_LINK(CheckHdl, void *);
 196
 197     FixedText                   maFtAllow;
 198     ListBox                     maLbAllow;
 199     CheckBox                    maCbAllow;      /// Allow blank cells.
 200     CheckBox                    maCbShow;       /// Show selection list in cell.
 201     CheckBox                    maCbSort;       /// Sort selection list in cell.
 202     FixedText                   maFtValue;
 203     ListBox                     maLbValue;
 204     FixedText                   maFtMin;
 205     formula::RefEdit            maEdMin;
 206     MultiLineEdit               maEdList;       /// Entries for explicit list
 207     FixedText                   maFtMax;
 208     formula::RefEdit            maEdMax;
 209     FixedText                   maFtHint;       /// Hint text for cell range validity.
 210
 211     OUString                    maStrMin;
 212     OUString                    maStrMax;
 213     OUString                    maStrValue;
 214     OUString                    maStrRange;
 215     OUString                    maStrList;
 216     sal_Unicode                 mcFmlaSep;      /// List separator in formulas.
 217
 218     Point                       maRefEditPos;
 219     Point                       maBtnRefPos;
 220     Size                        maRefEditSize;
 221     Size                        maBtnRefSize;
 222
 223     DECL_LINK(EditSetFocusHdl, void *);
 224     DECL_LINK( KillFocusHdl, Window *);
 225     void    OnClick( Button *pBtn );
 226     formula::RefEdit*           m_pRefEdit;
 227     class ScRefButtonEx:public ::formula::RefButton
 228     {
 229         void Click();
 230     public:
 231         ScRefButtonEx( Window* pParent, const ResId& rResId, formula::RefEdit* pEdit = NULL,
 232             ScRefHandler *pRefHdlr = NULL )
 233             : ::formula::RefButton( pParent, rResId, pEdit, pRefHdlr )
 234         {
 235         }
 236     }m_btnRef;
 237     friend class ScRefButtonEx;
 238     void            SetReferenceHdl( const ScRange& , ScDocument* );
 239     void            SetActiveHdl();
 240     void            RefInputStartPreHdl( formula::RefEdit* pEdit, formula::RefButton* pButton );
 241     void            RefInputDonePostHdl();
 242     ScValidationDlg * GetValidationDlg();
 243
 244     void            TidyListBoxes();
 245 public:
 246     sal_uInt16      GetAllowEntryPos();
 247     OUString        GetMinText();
 248     void            SetupRefDlg();
 249     void            RemoveRefDlg();
 250 };
 251
 252
 253 //==================================================================
 254
 255 class ScTPValidationHelp : public SfxTabPage
 256 {
 257 private:
 258     TriStateBox*      pTsbHelp;
 259     Edit*             pEdtTitle;
 260     VclMultiLineEdit* pEdInputHelp;
 261
 262     void    Init();
 263
 264     // Handler ------------------------
 265     // DECL_LINK( SelectHdl, ListBox * );
 266
 267 public:
 268             ScTPValidationHelp( Window* pParent, const SfxItemSet& rArgSet );
 269             ~ScTPValidationHelp();
 270
 271     static  SfxTabPage* Create      ( Window* pParent, const SfxItemSet& rArgSet );
 272     static  sal_uInt16*     GetRanges   ();
 273     virtual sal_Bool        FillItemSet ( SfxItemSet& rArgSet );
 274     virtual void        Reset       ( const SfxItemSet& rArgSet );
 275 };
 276
 277 //==================================================================
 278
 279 class ScTPValidationError : public SfxTabPage
 280 {
 281 private:
 282     TriStateBox* m_pTsbShow;
 283     ListBox* m_pLbAction;
 284     PushButton* m_pBtnSearch;
 285     Edit* m_pEdtTitle;
 286     FixedText* m_pFtError;
 287     VclMultiLineEdit* m_pEdError;
 288
 289     void    Init();
 290
 291     // Handler ------------------------
 292     DECL_LINK(SelectActionHdl, void *);
 293     DECL_LINK(ClickSearchHdl, void *);
 294
 295 public:
 296             ScTPValidationError( Window* pParent, const SfxItemSet& rArgSet );
 297             ~ScTPValidationError();
 298
 299     static  SfxTabPage* Create      ( Window* pParent, const SfxItemSet& rArgSet );
 300     static  sal_uInt16*     GetRanges   ();
 301     virtual sal_Bool        FillItemSet ( SfxItemSet& rArgSet );
 302     virtual void        Reset       ( const SfxItemSet& rArgSet );
 303 };
 304
 305 inline ScTabViewShell *ScValidationDlg::GetTabViewShell()
 306 {
 307     return m_pTabVwSh;
 308 }
 309
 310 inline ScValidationDlg * ScValidationDlg::Find1AliveObject( Window *pAncestor )
 311 {
 312     return static_cast<ScValidationDlg *>( SC_MOD()->Find1RefWindow( SLOTID, pAncestor ) );
 313 }
 314
 315 #endif // SC_VALIDATE_HXX
 316
 317 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */