LibreOffice Module dbaccess (master) 1
controllerframe.hxx
Go to the documentation of this file.
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_DBACCESS_CONTROLLERFRAME_HXX
21#define INCLUDED_DBACCESS_CONTROLLERFRAME_HXX
22
23#include <memory>
24
25#include <com/sun/star/frame/FrameAction.hpp>
26#include <com/sun/star/uno/Reference.hxx>
27
28namespace com::sun::star {
29 namespace frame { class XFrame; }
30}
31
32namespace dbaui
33{
34
35
36 class IController;
37
38
39 //= ControllerFrame
40
41 struct ControllerFrame_Data;
46 {
47 public:
48 ControllerFrame( IController& _rController );
50
52 const css::uno::Reference< css::frame::XFrame >&
54 const css::uno::Reference< css::frame::XFrame >& _rxFrame
55 );
56
57 // retrieves the current frame
58 const css::uno::Reference< css::frame::XFrame >&
59 getFrame() const;
60
63 bool isActive() const;
64
67 void frameAction( css::frame::FrameAction _eAction );
68
69 private:
70 ::std::unique_ptr< ControllerFrame_Data > m_pData;
71 };
72
73
74} // namespace dbaui
75
76
77#endif // INCLUDED_DBACCESS_CONTROLLERFRAME_HXX
78
79/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
helper class to encapsulate the frame which a controller is plugged into, doing some common actions o...
const css::uno::Reference< css::frame::XFrame > & getFrame() const
void frameAction(css::frame::FrameAction _eAction)
notifies the instance that a certain frame action happened with our frame
bool isActive() const
determines whether the frame is currently active
::std::unique_ptr< ControllerFrame_Data > m_pData
const css::uno::Reference< css::frame::XFrame > & attachFrame(const css::uno::Reference< css::frame::XFrame > &_rxFrame)
attaches a new frame
ControllerFrame(IController &_rController)