1 files changed, 116 insertions, 0 deletions
diff --git a/include/vcl/toolkit/roadmap.hxx b/include/vcl/toolkit/roadmap.hxx
new file mode 100644
index 000000000..ef1cec250
--- /dev/null
+++ b/include/vcl/toolkit/roadmap.hxx
@@ -0,0 +1,116 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
+#error "don't use this in new code"
+#endif
+
+#include <config_options.h>
+#include <vcl/dllapi.h>
+#include <vcl/ctrl.hxx>
+#include <vcl/toolkit/imgctrl.hxx>
+#include <memory>
+
+class Bitmap;
+
+namespace vcl
+{
+
+struct RoadmapTypes
+{
+public:
+    typedef sal_Int16 ItemId;
+    typedef sal_Int32 ItemIndex;
+};
+
+class HyperLabel;
+class RoadmapImpl;
+class RoadmapItem;
+
+class UNLESS_MERGELIBS(VCL_DLLPUBLIC) ORoadmap final : public Control, public RoadmapTypes
+{
+public:
+    ORoadmap( vcl::Window* _pParent, WinBits _nWinStyle );
+    virtual ~ORoadmap( ) override;
+    virtual void dispose() override;
+
+    void            SetRoadmapBitmap( const BitmapEx& maBitmap );
+
+    void            EnableRoadmapItem( ItemId _nItemId, bool _bEnable );
+
+    void            ChangeRoadmapItemLabel( ItemId _nID, const OUString& sLabel );
+    void            ChangeRoadmapItemID( ItemId _nID, ItemId NewID  );
+
+    void            SetRoadmapInteractive( bool _bInteractive );
+    bool            IsRoadmapInteractive() const;
+
+    void            SetRoadmapComplete( bool _bComplete );
+    bool            IsRoadmapComplete() const;
+
+    ItemIndex       GetItemCount() const;
+    ItemId          GetItemID( ItemIndex _nIndex ) const;
+
+    void            InsertRoadmapItem( ItemIndex Index, const OUString& RoadmapItem, ItemId _nUniqueId, bool _bEnabled );
+    void            ReplaceRoadmapItem( ItemIndex Index, const OUString& RoadmapItem, ItemId _nUniqueId, bool _bEnabled );
+    void            DeleteRoadmapItem( ItemIndex _nIndex );
+
+    ItemId          GetCurrentRoadmapItemID() const;
+    bool            SelectRoadmapItemByID(ItemId nItemID, bool bGrabFocus = true);
+
+    void            SetItemSelectHdl( const Link<LinkParamNone*,void>& _rHdl );
+    Link<LinkParamNone*,void> const & GetItemSelectHdl( ) const;
+    virtual void    DataChanged( const DataChangedEvent& rDCEvt ) override;
+    virtual void    GetFocus() override;
+    virtual void    ApplySettings( vcl::RenderContext& rRenderContext ) override;
+
+private:
+    bool            PreNotify( NotifyEvent& rNEvt ) override;
+
+    /// called when an item has been selected by any means
+    void            Select();
+
+    DECL_DLLPRIVATE_LINK(ImplClickHdl, HyperLabel*, void);
+
+    RoadmapItem*         GetByIndex( ItemIndex _nItemIndex );
+    const RoadmapItem*   GetByIndex( ItemIndex _nItemIndex ) const;
+
+    RoadmapItem*         GetByID( ItemId _nID  );
+    const RoadmapItem*   GetByID( ItemId _nID  ) const;
+    RoadmapItem*         GetPreviousHyperLabel( ItemIndex Index);
+
+    void                 DrawHeadline(vcl::RenderContext& rRenderContext);
+    void                 DeselectOldRoadmapItems();
+    ItemId               GetNextAvailableItemId( ItemIndex NewIndex );
+    ItemId               GetPreviousAvailableItemId( ItemIndex NewIndex );
+    RoadmapItem*         GetByPointer(vcl::Window const * pWindow);
+    RoadmapItem*         InsertHyperLabel( ItemIndex Index, const OUString& _aStr, ItemId RMID, bool _bEnabled, bool _bIncomplete  );
+    void                 UpdatefollowingHyperLabels( ItemIndex Index );
+
+    // Window overridables
+    void            Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& _rRect) override;
+    void            implInit(vcl::RenderContext& rRenderContext);
+
+    std::unique_ptr<RoadmapImpl>    m_pImpl;
+};
+
+}   // namespace vcl
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */