LibreOffice Module sw (master)  1
uitool.hxx
Go to the documentation of this file.
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  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef INCLUDED_SW_SOURCE_UIBASE_INC_UITOOL_HXX
20 #define INCLUDED_SW_SOURCE_UIBASE_INC_UITOOL_HXX
21 
22 #include <vcl/weld.hxx>
23 #include <swtypes.hxx>
24 #include <swdllapi.h>
25 
26 class SfxItemSet;
27 class SwPageDesc;
28 class SvxTabStopItem;
29 class SwWrtShell;
30 class ListBox;
31 namespace weld { class ComboBox; }
32 class SwDocShell;
33 class SwFrameFormat;
34 class SwTabCols;
35 class DateTime;
36 class SfxViewFrame;
37 class SwEditShell;
38 
39 // fill BoxInfo attribute
40 SW_DLLPUBLIC void PrepareBoxInfo(SfxItemSet& rSet, const SwWrtShell& rSh);
41 
48 
56 SW_DLLPUBLIC void ConvertAttrGenToChar(SfxItemSet& rSet, const SfxItemSet& rOrigSet);
57 
58 
67 void ApplyCharBackground(const Color& rBackgroundColor, SwWrtShell& rShell);
68 
69 // SfxItemSets <-> PageDesc
70 void ItemSetToPageDesc( const SfxItemSet& rSet, SwPageDesc& rPageDesc );
71 void PageDescToItemSet( const SwPageDesc& rPageDesc, SfxItemSet& rSet);
72 
73 // fill tabs with default tabs
74 SW_DLLPUBLIC void MakeDefTabs(SwTwips nDefDist, SvxTabStopItem& rTabs);
75 
76 // erase DefaultTabs from TabStopArray
77 //void EraseDefTabs(SvxTabStopItem& rTabs);
78 
79 // determine space between 1st and 2nd element
81 
82 // determine whether a Sfx-PageDesc combination exists in the set
83 // and set this in the set and delete the transport items
84 // (PageBreak & PageModel) from the set
85 void SwToSfxPageDescAttr( SfxItemSet& rSet );
86 void SfxToSwPageDescAttr( const SwWrtShell& rShell, SfxItemSet& rSet );
87 
89 void SetDfltMetric(FieldUnit eMetric, bool bWeb);
90 
91 bool HasCharUnit( bool bWeb );
92 void SetApplyCharUnit(bool bApplyChar, bool bWeb);
93 
94 // fill ListBox with all char style templates, except the standard ones
95 SW_DLLPUBLIC void FillCharStyleListBox(weld::ComboBox& rToFill, SwDocShell* pDocSh, bool bSorted = false, bool bWithDefault = false);
96 
97 //inserts a string sorted into a ListBox,
98 SW_DLLPUBLIC void InsertStringSorted(const OUString& rId, const OUString& rEntry, weld::ComboBox& rToFill, int nOffset);
99 
100 // Get table width and alignment
101 SwTwips GetTableWidth( SwFrameFormat const * pFormat, SwTabCols const & rCols, sal_uInt16 *pPercent,
102  SwWrtShell* pSh );
103 
104 OUString GetAppLangDateTimeString( const DateTime& );
105 
106 // search for a command string within the menu structure and execute it
107 // at the dispatcher if there is one, if executed return true
108 bool ExecuteMenuCommand( PopupMenu const & rMenu, SfxViewFrame const & rViewFrame, sal_uInt16 nId );
109 
110 #endif // INCLUDED_SW_SOURCE_UIBASE_INC_UITOOL_HXX
111 
112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FieldUnit
void ItemSetToPageDesc(const SfxItemSet &rSet, SwPageDesc &rPageDesc)
Definition: uitool.cxx:262
void SwToSfxPageDescAttr(SfxItemSet &rSet)
Definition: uitool.cxx:647
SwTwips GetTableWidth(SwFrameFormat const *pFormat, SwTabCols const &rCols, sal_uInt16 *pPercent, SwWrtShell *pSh)
Definition: uitool.cxx:753
SW_DLLPUBLIC void ConvertAttrCharToGen(SfxItemSet &rSet)
Convert character specific attributes to general ones used by tab pages.
Definition: uitool.cxx:104
SW_DLLPUBLIC void FillCharStyleListBox(weld::ComboBox &rToFill, SwDocShell *pDocSh, bool bSorted=false, bool bWithDefault=false)
Definition: uitool.cxx:711
SW_DLLPUBLIC SwTwips GetTabDist(const SvxTabStopItem &rTabs)
Definition: uitool.cxx:581
long SwTwips
Definition: swtypes.hxx:49
void SfxToSwPageDescAttr(const SwWrtShell &rShell, SfxItemSet &rSet)
Definition: uitool.cxx:587
OUString GetAppLangDateTimeString(const DateTime &)
Definition: uitool.cxx:794
bool HasCharUnit(bool bWeb)
Definition: uitool.cxx:804
void ApplyCharBackground(const Color &rBackgroundColor, SwWrtShell &rShell)
Apply character background on the shell.
Definition: uitool.cxx:179
Used by the UI to modify the document model.
Definition: wrtsh.hxx:90
Style of a layout element.
Definition: frmfmt.hxx:57
SW_DLLPUBLIC FieldUnit GetDfltMetric(bool bWeb)
Definition: uitool.cxx:686
SW_DLLPUBLIC void InsertStringSorted(const OUString &rId, const OUString &rEntry, weld::ComboBox &rToFill, int nOffset)
Definition: uitool.cxx:698
void SetApplyCharUnit(bool bApplyChar, bool bWeb)
Definition: uitool.cxx:809
#define SW_DLLPUBLIC
Definition: swdllapi.h:28
SW_DLLPUBLIC void MakeDefTabs(SwTwips nDefDist, SvxTabStopItem &rTabs)
Definition: uitool.cxx:569
void PageDescToItemSet(const SwPageDesc &rPageDesc, SfxItemSet &rSet)
Definition: uitool.cxx:405
bool ExecuteMenuCommand(PopupMenu const &rMenu, SfxViewFrame const &rViewFrame, sal_uInt16 nId)
Definition: uitool.cxx:814
SW_DLLPUBLIC void PrepareBoxInfo(SfxItemSet &rSet, const SwWrtShell &rSh)
Definition: uitool.cxx:79
void SetDfltMetric(FieldUnit eMetric, bool bWeb)
Definition: uitool.cxx:693
SW_DLLPUBLIC void ConvertAttrGenToChar(SfxItemSet &rSet, const SfxItemSet &rOrigSet)
Convert general attributes to the corresponding character attributes.
Definition: uitool.cxx:138