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, const OUString &rExt);
  58     bool isValid (const OUString& rPath) const;
  59
  60 private:
  61
  62     FILTER_APPLICATION const mApp;
  63 };
  64
  65
  66 class TemplateLocalView : public ThumbnailView
  67 {
  68     typedef bool (*selection_cmp_fn)(const ThumbnailViewItem*,const ThumbnailViewItem*);
  69
  70 public:
  71
  72     TemplateLocalView ( vcl::Window* pParent );
  73
  74     virtual ~TemplateLocalView () override;
  75     virtual void dispose() override;
  76
  77     // Fill view with new item list
  78     void insertItems (const std::vector<TemplateItemProperties> &rTemplates, bool isRegionSelected = true, bool bShowCategoryInTooltip = false);
  79
  80     // Fill view with template folders thumbnails
  81     void Populate ();
  82
  83     virtual void reload ();
  84
  85     virtual void showAllTemplates ();
  86
  87     void showRegion (TemplateContainerItem const *pItem);
  88
  89     DECL_LINK(ContextMenuSelectHdl, Menu*, bool);
  90
  91     virtual bool renameItem(ThumbnailViewItem* pItem, const OUString& sNewTitle) override;
  92
  93     virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
  94
  95     virtual void RequestHelp( const HelpEvent& rHEvt ) override;
  96
  97     virtual void Command( const CommandEvent& rCEvt ) override;
  98
  99     virtual void KeyInput( const KeyEvent& rKEvt ) override;
 100
 101     void setCreateContextMenuHdl(const Link<ThumbnailViewItem*,void> &rLink);
 102
 103     void setOpenTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 104
 105     void setEditTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 106
 107     void updateThumbnailDimensions(long itemMaxSize);
 108
 109     static BitmapEx scaleImg (const BitmapEx &rImg, long width, long height);
 110
 111     static BitmapEx getDefaultThumbnail( const OUString& rPath );
 112
 113     static BitmapEx fetchThumbnail (const OUString &msURL, long width, long height);
 114
 115     static bool IsDefaultTemplate(const OUString& rPath);
 116
 117 protected:
 118     virtual void OnItemDblClicked(ThumbnailViewItem *pItem) override;
 119
 120 protected:
 121     sal_uInt16 mnCurRegionId;
 122
 123     TemplateViewItem *maSelectedItem;
 124
 125     long mnThumbnailWidth;
 126     long mnThumbnailHeight;
 127
 128     Point maPosition; //store the point of click event
 129
 130     Link<ThumbnailViewItem*,void> maCreateContextMenuHdl;
 131     Link<ThumbnailViewItem*,void> maOpenTemplateHdl;
 132     Link<ThumbnailViewItem*,void> maEditTemplateHdl;
 133
 134     std::unique_ptr<SfxDocumentTemplates> mpDocTemplates;
 135     std::vector<std::unique_ptr<TemplateContainerItem> > maRegions;
 136     std::vector<TemplateItemProperties > maAllTemplates;
 137 };
 138
 139 class SfxTemplateLocalView final : public SfxThumbnailView
 140 {
 141     typedef bool (*selection_cmp_fn)(const ThumbnailViewItem*,const ThumbnailViewItem*);
 142
 143 public:
 144
 145     SfxTemplateLocalView(std::unique_ptr<weld::ScrolledWindow> xWindow,
 146                          std::unique_ptr<weld::Menu> xMenu);
 147
 148     virtual ~SfxTemplateLocalView () override;
 149
 150     // Fill view with new item list
 151     void insertItems (const std::vector<TemplateItemProperties> &rTemplates, bool isRegionSelected = true, bool bShowCategoryInTooltip = false);
 152
 153     // Fill view with template folders thumbnails
 154     void Populate ();
 155
 156     void reload ();
 157
 158     void showAllTemplates ();
 159
 160     void showRegion (TemplateContainerItem const *pItem);
 161
 162     void showRegion (const OUString &rName);
 163
 164     void createContextMenu(const bool bIsDefault );
 165
 166     void ContextMenuSelectHdl(const OString& rIdent);
 167
 168     TemplateContainerItem* getRegion(OUString const & sStr);
 169
 170     sal_uInt16 getRegionId (size_t pos) const;
 171
 172     sal_uInt16 getRegionId (OUString const & sRegionName) const;
 173
 174     OUString getRegionName(const sal_uInt16 nRegionId) const;
 175
 176     OUString getRegionItemName(const sal_uInt16 nItemId) const;
 177
 178     std::vector<OUString> getFolderNames ();
 179
 180     std::vector<TemplateItemProperties>
 181         getFilteredItems (const std::function<bool (const TemplateItemProperties&) > &rFunc) const;
 182
 183     sal_uInt16 createRegion (const OUString &rName);
 184
 185     bool renameRegion(const OUString &rTitle, const OUString &rNewTitle);
 186
 187     bool removeRegion (const sal_uInt16 nItemId);
 188
 189     bool removeTemplate (const sal_uInt16 nItemId, const sal_uInt16 nSrcItemId);
 190
 191     bool moveTemplate (const ThumbnailViewItem* pItem, const sal_uInt16 nSrcItem,
 192                        const sal_uInt16 nTargetItem);
 193
 194     void moveTemplates (const std::set<const ThumbnailViewItem*,selection_cmp_fn> &rItems, const sal_uInt16 nTargetItem);
 195
 196     bool copyFrom(TemplateContainerItem *pItem, const OUString &rPath);
 197
 198     bool exportTo (const sal_uInt16 nItemId, const sal_uInt16 nRegionItemId, const OUString &rName);
 199
 200     virtual bool renameItem(ThumbnailViewItem* pItem, const OUString& sNewTitle) override;
 201
 202     virtual bool MouseButtonDown( const MouseEvent& rMEvt ) override;
 203
 204     virtual bool Command(const CommandEvent& rPos) override;
 205
 206     virtual bool KeyInput( const KeyEvent& rKEvt ) override;
 207
 208     sal_uInt16 getCurRegionId () const { return mnCurRegionId;}
 209
 210     void setOpenRegionHdl(const Link<void*,void> &rLink);
 211
 212     void setCreateContextMenuHdl(const Link<ThumbnailViewItem*,void> &rLink);
 213
 214     void setOpenTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 215
 216     void setEditTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 217
 218     void setDeleteTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 219
 220     void setDefaultTemplateHdl(const Link<ThumbnailViewItem*,void> &rLink);
 221
 222     void RemoveDefaultTemplateIcon( const OUString& rPath);
 223
 224     static BitmapEx scaleImg (const BitmapEx &rImg, long width, long height);
 225
 226     static BitmapEx getDefaultThumbnail( const OUString& rPath );
 227
 228     static BitmapEx fetchThumbnail (const OUString &msURL, long width, long height);
 229
 230     static bool IsDefaultTemplate(const OUString& rPath);
 231
 232 private:
 233     virtual void OnItemDblClicked(ThumbnailViewItem *pItem) override;
 234
 235     sal_uInt16 mnCurRegionId;
 236
 237     TemplateViewItem *maSelectedItem;
 238
 239     Point maPosition; //store the point of click event
 240
 241     Link<void*,void>              maOpenRegionHdl;
 242     Link<ThumbnailViewItem*,void> maCreateContextMenuHdl;
 243     Link<ThumbnailViewItem*,void> maOpenTemplateHdl;
 244     Link<ThumbnailViewItem*,void> maEditTemplateHdl;
 245     Link<ThumbnailViewItem*,void> maDeleteTemplateHdl;
 246     Link<ThumbnailViewItem*,void> maDefaultTemplateHdl;
 247
 248     std::unique_ptr<SfxDocumentTemplates> mpDocTemplates;
 249     std::vector<std::unique_ptr<TemplateContainerItem> > maRegions;
 250     std::vector<TemplateItemProperties > maAllTemplates;
 251 };
 252
 253
 254 #endif // INCLUDED_SFX2_TEMPLATELOCALVIEW_HXX
 255
 256 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */