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_SD_SOURCE_UI_SIDEBAR_MASTERPAGECONTAINERFILLER_HXX
21 #define INCLUDED_SD_SOURCE_UI_SIDEBAR_MASTERPAGECONTAINERFILLER_HXX
22 
23 #include <memory>
24 #include "MasterPageContainer.hxx"
25 #include "MasterPageDescriptor.hxx"
26 #include <tools/AsynchronousTask.hxx>
27 
28 namespace sd {
29 class TemplateScanner;
30 class TemplateEntry;
31 }
32 
33 namespace sd { namespace sidebar {
34 
35 /** Fill a MasterPageContainer with information about the available master
36     pages.  These are provided by one default page and from the existing
37     Impress templates.  This is done asynchronously.
38 */
39 class MasterPageContainerFiller
40     : public ::sd::tools::AsynchronousTask
41 {
42 public:
43     class ContainerAdapter
44     {
45     public:
46         virtual MasterPageContainer::Token PutMasterPage (
47             const SharedMasterPageDescriptor& rpDescriptor) = 0;
48         /** This method is called when all Impress templates have been added
49             to the container via the PutMasterPage() method.
50         */
51         virtual void FillingDone() = 0;
52 
53     protected:
~ContainerAdapter()54         ~ContainerAdapter() {}
55     };
56 
57     explicit MasterPageContainerFiller (ContainerAdapter& rContainerAdapter);
58     virtual ~MasterPageContainerFiller();
59 
60     /** Run the next step of the task.  After HasNextStep() returns false
61         this method should ignore further calls.
62     */
63     virtual void RunNextStep() override;
64 
65     /** Return <TRUE/> when there is at least one more step to execute.
66         When the task has been executed completely then <FALSE/> is
67         returned.
68     */
69     virtual bool HasNextStep() override;
70 
71 private:
72     ContainerAdapter& mrContainerAdapter;
73     // Remember what the next step has to do.
74     enum State {
75         INITIALIZE_TEMPLATE_SCANNER,
76         SCAN_TEMPLATE,
77         ADD_TEMPLATE,
78         ERROR,
79         DONE
80     } meState;
81     ::std::unique_ptr<TemplateScanner> mpScannerTask;
82     const TemplateEntry* mpLastAddedEntry;
83     int mnIndex;
84 
85     State ScanTemplate();
86     State AddTemplate();
87 };
88 
89 } } // end of namespace sd::sidebar
90 
91 #endif
92 
93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
94