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