office-gobmx/svtools/inc/roadmap.hxx
Noel Grandin f49b6d89fd loplugin:finalclasses in svtools
Change-Id: I596342a3d32e116ac5994b60a5bd8717d4f6a5dd
Reviewed-on: https://gerrit.libreoffice.org/43733
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2017-10-24 10:54:23 +02:00

114 lines
4.2 KiB
C++

/* -*- 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_SVTOOLS_INC_ROADMAP_HXX
#define INCLUDED_SVTOOLS_INC_ROADMAP_HXX
#include <svtools/svtdllapi.h>
#include <vcl/ctrl.hxx>
#include <vcl/imgctrl.hxx>
#include <svtools/hyperlabel.hxx>
#include <memory>
class Bitmap;
namespace svt
{
struct RoadmapTypes
{
public:
typedef sal_Int16 ItemId;
typedef sal_Int32 ItemIndex;
};
class RoadmapImpl;
class RoadmapItem;
class SVT_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();
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 );
void SetItemSelectHdl( const Link<LinkParamNone*,void>& _rHdl );
Link<LinkParamNone*,void> 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_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 svt
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */