include/svx/sdrpageuser.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 _SDR_PAGEUSER_HXX
  21 #define _SDR_PAGEUSER_HXX
  22
  23 #include <vector>
  24
  25 ////////////////////////////////////////////////////////////////////////////////////////////////////
  26 // predeclarations
  27 class SdrPage;
  28
  29 ////////////////////////////////////////////////////////////////////////////////////////////////////
  30 // To make things more safe, allow users of the page to register at it. The users need to be derived
  31 // from sdr::PageUser to get a call. The users do not need to call RemovePageUser() at the page
  32 // when they get called from PageInDestruction().
  33
  34 namespace sdr
  35 {
  36     class PageUser
  37     {
  38     public:
  39         // this method is called form the destructor of the referenced page.
  40         // do all necessary action to forget the page. It is not necessary to call
  41         // RemovePageUser(), that is done form the destructor.
  42         virtual void PageInDestruction(const SdrPage& rPage) = 0;
  43
  44     protected:
  45         ~PageUser() {}
  46     };
  47
  48     // typedef for PageUserVector
  49     typedef ::std::vector< PageUser* > PageUserVector;
  50 } // end of namespace sdr
  51
  52 ////////////////////////////////////////////////////////////////////////////////////////////////////
  53
  54 #endif //_SDR_PAGEUSER_HXX
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */