include/sfx2/templatelocalview.hxx

   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
  10 #ifndef INCLUDED_SFX2_TEMPLATELOCALVIEW_HXX
  11 #define INCLUDED_SFX2_TEMPLATELOCALVIEW_HXX
  12
  13 #include <sfx2/thumbnailview.hxx>
  14 #include <sfx2/templateproperties.hxx>
  15 #include <functional>
  16 #include <memory>
  17 #include <set>
  18
  19 //template thumbnail item defines
  20 #define TEMPLATE_ITEM_MAX_WIDTH 160
  21 #define TEMPLATE_ITEM_MAX_HEIGHT 148
  22 #define TEMPLATE_ITEM_PADDING 5
  23 #define TEMPLATE_ITEM_MAX_TEXT_LENGTH 20
  24 #define TEMPLATE_ITEM_THUMBNAIL_MAX_HEIGHT 96
  25
  26 //template thumbnail height with a subtitle
  27 #define TEMPLATE_ITEM_MAX_HEIGHT_SUB 160
  28
  29 //template thumbnail image defines
  30 #define TEMPLATE_THUMBNAIL_MAX_HEIGHT TEMPLATE_ITEM_THUMBNAIL_MAX_HEIGHT - 2*TEMPLATE_ITEM_PADDING
  31 #define TEMPLATE_THUMBNAIL_MAX_WIDTH TEMPLATE_ITEM_MAX_WIDTH - 2*TEMPLATE_ITEM_PADDING
  32
  33 class SfxDocumentTemplates;
  34 class TemplateContainerItem;
  35 class TemplateViewItem;
  36
  37 enum class FILTER_APPLICATION
  38 {
  39     NONE,
  40     WRITER,
  41     CALC,
  42     IMPRESS,
  43     DRAW
  44 };
  45
  46 // Display template items depending on the generator application
  47 class ViewFilter_Application final
  48 {
  49 public:
  50
  51     ViewFilter_Application (FILTER_APPLICATION App)
  52         : mApp(App)
  53     {}
  54
  55     bool operator () (const ThumbnailViewItem *pItem);
  56
  57     static bool isFilteredExtension(FILTER_APPLICATION filter, std::u16string_view rExt);
  58     bool isValid (const OUString& rPath) const;
  59
  60 private:
  61
  62     FILTER_APPLICATION mApp;
  63 };
  64
  65 class TemplateLocalView : public ThumbnailView
  66 {
  67     typedef bool (*selection_cmp_fn)(const ThumbnailViewItem*,const ThumbnailViewItem*);
  68
  69 public:
  70
  71     TemplateLocalView(std::unique_ptr<weld::ScrolledWindow> xWindow,
  72                          std::unique_ptr<weld::Menu> xMenu);
  73
  74     virtual ~TemplateLocalView () override;
  75
  76     // Fill view with new item list
  77     void insertItems (const std::vector<TemplateItemProperties> &rTemplates, bool isRegionSelected = true, bool bShowCategoryInTooltip = false);
  78
  79     // Fill view with template folders thumbnails
  80     void Populate ();
  81
  82     void reload ();
  83
  84     virtual void showAllTemplates ();
  85
  86     void showRegion (TemplateContainerItem const *pItem);
  87
  88     void ContextMenuSelectHdl(std::string_view  rIdent);
  89
  90     TemplateContainerItem* getRegion(std::u16string_view sStr);
  91
  92     sal_uInt16 getRegionId (size_t pos) const;
  93
  94     sal_uInt16 getRegionId (std::u16string_view sRegionName) const;
  95
  96     OUString getRegionName(const sal_uInt16 nRegionId) const;
  97
  98     OUString getRegionItemName(const sal_uInt16 nItemId) const;
  99
 100     std::vector<OUString> getFolderNames ();
 101
 102     std::vector<TemplateItemProperties>
 103         getFilteredItems (const std::function<bool (const TemplateItemProperties&) > &rFunc) const;
 104
 105     sal_uInt16 createRegion (const OUString &rName);
 106
 107     bool renameRegion(std::u16string_view rTitle, const OUString &rNewTitle);
 108
 109     bool removeRegion (const sal_uInt16 nItemId);
 110
 111     bool removeTemplate (const sal_uInt16 nItemId, const sal_uInt16 nSrcItemId);
 112
 113     void moveTemplates (const std::set<const ThumbnailViewItem*,selection_cmp_fn> &rItems, const sal_uInt16 nTargetItem);
 114
 115     bool copyFrom(TemplateContainerItem *pItem, const OUString &rPath);
 116
 117     bool exportTo (const sal_uInt16 nItemId, const sal_uInt16 nRegionItemId, const OUString &rName);
 118
 119     virtual bool renameItem(ThumbnailViewItem* pItem, const OUString& sNewTitle) override;
 120
 121     virtual bool MouseButtonDown( const MouseEvent& rMEvt ) override;
 122
 123     virtual bool Command(const CommandEvent& rPos) override;
 124
 125     virtual bool KeyInput( const KeyEvent& rKEvt ) override;
 126
 127     sal_uInt16 getCurRegionId () const { return mnCurRegionId;}
 128
 129     void setCurRegionId (sal_uInt16 nCurRegionId) { mnCurRegionId = nCurRegionId;}
 130
 131     void setOpenRegionHdl(const Link<void*,void> &rLink);
 132
 133     void setCreateContextMenuHdl(const Link<ThumbnailViewItem*,void> &rLink);
 134
 135     void setOpenTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 136
 137     void setEditTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 138
 139     void setDeleteTemplateHdl(const Link<void*,void> &rLink);
 140
 141     void setDefaultTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 142
 143     void setMoveTemplateHdl(const Link<void*,void> &rLink);
 144
 145     void setExportTemplateHdl(const Link<void*,void> &rLink);
 146
 147     void updateThumbnailDimensions(tools::Long itemMaxSize);
 148
 149     void RemoveDefaultTemplateIcon( std::u16string_view rPath);
 150
 151     bool IsBuiltInRegion(const OUString& rRegionName);
 152
 153     static BitmapEx scaleImg (const BitmapEx &rImg, tools::Long width, tools::Long height);
 154
 155     static BitmapEx getDefaultThumbnail( const OUString& rPath );
 156
 157     static BitmapEx fetchThumbnail (const OUString &msURL, tools::Long width, tools::Long height);
 158
 159     static bool IsDefaultTemplate(const OUString& rPath);
 160
 161     static bool IsInternalTemplate(const OUString& rPath);
 162
 163 protected:
 164     virtual void OnItemDblClicked(ThumbnailViewItem *pItem) override;
 165
 166     sal_uInt16 mnCurRegionId;
 167
 168     TemplateViewItem *maSelectedItem;
 169
 170     tools::Long mnThumbnailWidth;
 171     tools::Long mnThumbnailHeight;
 172
 173     Point maPosition; //store the point of click event
 174
 175     Link<void*,void>              maOpenRegionHdl;
 176     Link<ThumbnailViewItem*,void> maCreateContextMenuHdl;
 177     Link<ThumbnailViewItem*,void> maOpenTemplateHdl;
 178     Link<ThumbnailViewItem*,void> maEditTemplateHdl;
 179     Link<void*,void> maDeleteTemplateHdl;
 180     Link<ThumbnailViewItem*,void> maDefaultTemplateHdl;
 181     Link<void*,void> maMoveTemplateHdl;
 182     Link<void*,void> maExportTemplateHdl;
 183
 184     std::unique_ptr<SfxDocumentTemplates> mpDocTemplates;
 185     std::vector<std::unique_ptr<TemplateContainerItem> > maRegions;
 186     std::vector<TemplateItemProperties > maAllTemplates;
 187 };
 188
 189
 190 #endif // INCLUDED_SFX2_TEMPLATELOCALVIEW_HXX
 191
 192 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */