1c45d927aSAndrew Rist /**************************************************************
2*3e459a30Smseidel  *
3c45d927aSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4c45d927aSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5c45d927aSAndrew Rist  * distributed with this work for additional information
6c45d927aSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7c45d927aSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8c45d927aSAndrew Rist  * "License"); you may not use this file except in compliance
9c45d927aSAndrew Rist  * with the License.  You may obtain a copy of the License at
10*3e459a30Smseidel  *
11c45d927aSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12*3e459a30Smseidel  *
13c45d927aSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14c45d927aSAndrew Rist  * software distributed under the License is distributed on an
15c45d927aSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16c45d927aSAndrew Rist  * KIND, either express or implied.  See the License for the
17c45d927aSAndrew Rist  * specific language governing permissions and limitations
18c45d927aSAndrew Rist  * under the License.
19*3e459a30Smseidel  *
20c45d927aSAndrew Rist  *************************************************************/
21c45d927aSAndrew Rist 
22c45d927aSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef SD_TASKPANE_CONTROL_FACTORY_HXX
25cdf0e10cSrcweir #define SD_TASKPANE_CONTROL_FACTORY_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include "taskpane/TaskPaneTreeNode.hxx"
28cdf0e10cSrcweir 
29cdf0e10cSrcweir #include <memory>
30cdf0e10cSrcweir 
31cdf0e10cSrcweir namespace sd {
32cdf0e10cSrcweir class ViewShellBase;
33cdf0e10cSrcweir }
34cdf0e10cSrcweir 
35cdf0e10cSrcweir namespace sd { namespace toolpanel {
36cdf0e10cSrcweir class TreeNode;
37cdf0e10cSrcweir } }
38cdf0e10cSrcweir 
39cdf0e10cSrcweir 
40cdf0e10cSrcweir 
41cdf0e10cSrcweir 
42cdf0e10cSrcweir namespace sd { namespace toolpanel {
43cdf0e10cSrcweir 
44cdf0e10cSrcweir /** A simple factory base class defines the interface that is used by
45*3e459a30Smseidel 	some of the control containers of the task pane to create controls on
46*3e459a30Smseidel 	demand when they are about to be displayed for the first time.
47cdf0e10cSrcweir 
48*3e459a30Smseidel 	It provides the InternalCreateControl() method as hook that can be
49*3e459a30Smseidel 	overloaded by derived classes to provide a new control.
50cdf0e10cSrcweir */
51cdf0e10cSrcweir class ControlFactory
52cdf0e10cSrcweir {
53cdf0e10cSrcweir public:
54*3e459a30Smseidel 	ControlFactory (void);
55*3e459a30Smseidel 	virtual ~ControlFactory (void);
56cdf0e10cSrcweir 
57*3e459a30Smseidel 	/** creates a tree node which acts as root of an own tree
58cdf0e10cSrcweir 
59*3e459a30Smseidel 		Derived classes should overload InternalCreateControl.
60*3e459a30Smseidel 	*/
61*3e459a30Smseidel 	::std::auto_ptr<TreeNode> CreateControl( ::Window& i_rParent );
62cdf0e10cSrcweir 
63cdf0e10cSrcweir protected:
64*3e459a30Smseidel 	virtual TreeNode* InternalCreateControl( ::Window& i_rParent ) = 0;
65cdf0e10cSrcweir };
66cdf0e10cSrcweir 
67cdf0e10cSrcweir 
68cdf0e10cSrcweir 
69cdf0e10cSrcweir /** A simple helper class that realizes a ControlFactory that is able to create root controls, providing
70*3e459a30Smseidel 	the to-be-created control with an additional parameter.
71cdf0e10cSrcweir */
72cdf0e10cSrcweir template<class ControlType, class ArgumentType>
73cdf0e10cSrcweir class RootControlFactoryWithArg
74*3e459a30Smseidel 	: public ControlFactory
75cdf0e10cSrcweir {
76cdf0e10cSrcweir public:
RootControlFactoryWithArg(ArgumentType & rArgument)77*3e459a30Smseidel 	RootControlFactoryWithArg (ArgumentType& rArgument)
78*3e459a30Smseidel 		: mrArgument(rArgument)
79*3e459a30Smseidel 	{}
80cdf0e10cSrcweir 
81cdf0e10cSrcweir protected:
InternalCreateControl(::Window & i_rParent)82*3e459a30Smseidel 	virtual TreeNode* InternalCreateControl( ::Window& i_rParent )
83*3e459a30Smseidel 	{
84*3e459a30Smseidel 		return new ControlType( i_rParent, mrArgument );
85*3e459a30Smseidel 	}
86cdf0e10cSrcweir 
87cdf0e10cSrcweir private:
88*3e459a30Smseidel 	ArgumentType& mrArgument;
89cdf0e10cSrcweir };
90cdf0e10cSrcweir 
91cdf0e10cSrcweir 
92cdf0e10cSrcweir } } // end of namespace ::sd::toolpanel
93cdf0e10cSrcweir 
94cdf0e10cSrcweir #endif
95