sd/source/ui/inc/ViewShellHint.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: ViewShellHint.hxx,v $
  10  * $Revision: 1.5 $
  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
  31 #ifndef SD_VIEW_SHELL_HINT_HXX
  32 #define SD_VIEW_SHELL_HINT_HXX
  33
  34 #include <svtools/hint.hxx>
  35
  36 namespace sd {
  37
  38 /** Local derivation of the SfxHint class that defines some hint ids that
  39     are used by the ViewShell class and its decendants.
  40 */
  41 class ViewShellHint
  42     : public SfxHint
  43 {
  44 public:
  45     enum HintId {
  46         // Indicate that a page resize is about to begin.
  47         HINT_PAGE_RESIZE_START,
  48         // Indicate that a page resize has been completed.
  49         HINT_PAGE_RESIZE_END,
  50         // Indicate that an edit mode change is about to begin.
  51         HINT_CHANGE_EDIT_MODE_START,
  52         // Indicate that an edit mode change has been completed.
  53         HINT_CHANGE_EDIT_MODE_END,
  54
  55         HINT_COMPLEX_MODEL_CHANGE_START,
  56         HINT_COMPLEX_MODEL_CHANGE_END
  57     };
  58
  59     TYPEINFO();
  60
  61     ViewShellHint (HintId nHintId);
  62
  63     HintId GetHintId (void) const;
  64
  65 private:
  66     HintId meHintId;
  67 };
  68
  69 } // end of namespace sd
  70
  71 #endif