diff options
Diffstat (limited to '')
-rw-r--r-- | include/sfx2/sidebar/Panel.hxx | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/include/sfx2/sidebar/Panel.hxx b/include/sfx2/sidebar/Panel.hxx new file mode 100644 index 000000000..cae82bbc1 --- /dev/null +++ b/include/sfx2/sidebar/Panel.hxx @@ -0,0 +1,94 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef INCLUDED_SFX2_SOURCE_SIDEBAR_PANEL_HXX +#define INCLUDED_SFX2_SOURCE_SIDEBAR_PANEL_HXX + +#include <sfx2/dllapi.h> + +#include <vcl/window.hxx> + +#include <vector> + +namespace com::sun::star::frame { class XFrame; } +namespace com::sun::star::ui { class XSidebarPanel; } +namespace com::sun::star::ui { class XUIElement; } +namespace com::sun::star::awt { class XWindow; } + +namespace sfx2::sidebar { + +class PanelDescriptor; +class PanelTitleBar; +class Context; + +/** + * Multiple panels form a single deck. + * E.g. the Properties deck has panels like Styles, Character, paragraph. + */ +class SFX2_DLLPUBLIC Panel final : public vcl::Window +{ +public: + Panel(const PanelDescriptor& rPanelDescriptor, vcl::Window* pParentWindow, + const bool bIsInitiallyExpanded, const std::function<void()>& rDeckLayoutTrigger, + const std::function<Context()>& rContextAccess, + const css::uno::Reference<css::frame::XFrame>& rxFrame); + + virtual ~Panel() override; + virtual void dispose() override; + + VclPtr<PanelTitleBar> const & GetTitleBar() const; + bool IsTitleBarOptional() const { return mbIsTitleBarOptional;} + void SetUIElement (const css::uno::Reference<css::ui::XUIElement>& rxElement); + const css::uno::Reference<css::ui::XSidebarPanel>& GetPanelComponent() const { return mxPanelComponent;} + css::uno::Reference<css::awt::XWindow> GetElementWindow(); + void SetExpanded (const bool bIsExpanded); + bool IsExpanded() const { return mbIsExpanded;} + bool HasIdPredicate (const OUString& rsId) const; + const OUString& GetId() const { return msPanelId;} + void TriggerDeckLayouting() { maDeckLayoutTrigger(); } + + /// Set whether a panel should be present but invisible / inactive + void SetLurkMode(bool bLurk); + bool IsLurking() const { return mbLurking; } + + virtual void Resize() override; + virtual void DataChanged (const DataChangedEvent& rEvent) override; + virtual void ApplySettings(vcl::RenderContext& rRenderContext) override; + virtual boost::property_tree::ptree DumpAsPropertyTree() override; + +private: + const OUString msPanelId; + VclPtr<PanelTitleBar> mpTitleBar; + const bool mbIsTitleBarOptional; + css::uno::Reference<css::ui::XUIElement> mxElement; + css::uno::Reference<css::ui::XSidebarPanel> mxPanelComponent; + bool mbIsExpanded; + bool mbLurking; + const std::function<void()> maDeckLayoutTrigger; + const std::function<Context()> maContextAccess; + + const css::uno::Reference<css::frame::XFrame>& mxFrame; + +}; +typedef std::vector<VclPtr<Panel> > SharedPanelContainer; + +} // end of namespace sfx2::sidebar + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |