/* -*- 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/. */ #ifndef INCLUDED_VCL_BUILDER_HXX #define INCLUDED_VCL_BUILDER_HXX #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifdef check # //some problem with MacOSX and a check define # undef check #endif #include #include class ListBox; class NumericFormatter; class PopupMenu; class ScrollBar; class Slider; class DateField; class TimeField; class VclExpander; class VclMultiLineEdit; namespace xmlreader { class XmlReader; } class VCL_DLLPUBLIC VclBuilder { public: typedef std::map stringmap; typedef std::map> accelmap; /// These functions create a new widget with parent pParent and return it in rRet typedef void (*customMakeWidget)(VclPtr &rRet, VclPtr &pParent, stringmap &rVec); public: VclBuilder( vcl::Window *pParent, const OUString& sUIRootDir, const OUString& sUIFile, const OString& sID = OString(), const css::uno::Reference &rFrame = css::uno::Reference()); ~VclBuilder(); ///releases references and disposes all children. void disposeBuilder(); //sID must exist and be of type T template T* get(VclPtr& ret, const OString& sID); //sID may not exist, but must be of type T if it does template T* get(const OString& sID); vcl::Window* get_widget_root(); //sID may not exist PopupMenu* get_menu(const OString& sID); //given an sID return the response value for that widget short get_response(const vcl::Window *pWindow) const; //release ownership of pWindow, i.e. don't delete it void drop_ownership(const vcl::Window *pWindow); //see m_aDeferredProperties, you need this for toplevel dialogs //which build themselves from their ctor. The properties on //the top level are stored in m_aDeferredProperties and need //to be applied post ctor void setDeferredProperties(); /// return UI-File name (without '.ui') const OString& getUIFile() const { return m_sHelpRoot; } private: VclBuilder(const VclBuilder&) = delete; VclBuilder& operator=(const VclBuilder&) = delete; typedef std::map> ModuleMap; //We store these until the builder is deleted, that way we can use the //ui-previewer on custom widgets and guarantee the modules they are from //exist for the duration of the dialog ModuleMap m_aModuleMap; //If the toplevel window has any properties which need to be set on it, //but the toplevel is the owner of the builder, then its ctor //has not been completed during the building, so properties for it //are collected here and need to be set afterwards, e.g. during //Show or Execute stringmap m_aDeferredProperties; struct PackingData { bool m_bVerticalOrient; sal_Int32 m_nPosition; PackingData(bool bVerticalOrient = false) : m_bVerticalOrient(bVerticalOrient) , m_nPosition(-1) { } }; struct WinAndId { OString m_sID; VclPtr m_pWindow; short m_nResponseId; PackingData m_aPackingData; WinAndId(const OString &rId, vcl::Window *pWindow, bool bVertical) : m_sID(rId) , m_pWindow(pWindow) , m_nResponseId(RET_CANCEL) , m_aPackingData(bVertical) { } }; std::vector m_aChildren; struct MenuAndId { OString m_sID; VclPtr m_pMenu; MenuAndId(const OString &rId, PopupMenu *pMenu); ~MenuAndId(); }; std::vector m_aMenus; struct StringPair { OString m_sID; OString m_sValue; StringPair(const OString &rId, const OString &rValue) : m_sID(rId) , m_sValue(rValue) { } }; struct UStringPair { OString m_sID; OUString m_sValue; UStringPair(const OString &rId, const OUString &rValue) : m_sID(rId) , m_sValue(rValue) { } }; typedef StringPair RadioButtonGroupMap; struct ButtonImageWidgetMap { OString m_sID; OUString m_sValue; bool m_bRadio; ButtonImageWidgetMap(const OString &rId, const OUString &rValue, bool bRadio) : m_sID(rId) , m_sValue(rValue) , m_bRadio(bRadio) { } }; typedef UStringPair TextBufferMap; typedef UStringPair WidgetAdjustmentMap; typedef UStringPair ButtonMenuMap; typedef UStringPair MnemonicWidgetMap; struct ComboBoxModelMap { OString m_sID; OUString m_sValue; sal_Int32 m_nActiveId; ComboBoxModelMap(const OString &rId, const OUString &rValue, sal_Int32 nActiveId) : m_sID(rId) , m_sValue(rValue) , m_nActiveId(nActiveId) { } }; struct ListStore { typedef std::vector row; std::vector m_aEntries; }; const ListStore* get_model_by_name(const OString& sID) const; static void mungeModel(ListBox &rTarget, const ListStore &rStore, sal_uInt16 nActiveId); typedef stringmap TextBuffer; const TextBuffer* get_buffer_by_name(const OString& sID) const; static void mungeTextBuffer(VclMultiLineEdit &rTarget, const TextBuffer &rTextBuffer); typedef stringmap Adjustment; const Adjustment* get_adjustment_by_name(const OString& sID) const; static void mungeAdjustment(NumericFormatter &rTarget, const Adjustment &rAdjustment); static void mungeAdjustment(DateField &rTarget, const Adjustment &rAdjustment); static void mungeAdjustment(TimeField &rTarget, const Adjustment &rAdjustment); static void mungeAdjustment(ScrollBar &rTarget, const Adjustment &rAdjustment); static void mungeAdjustment(Slider &rTarget, const Adjustment &rAdjustment); struct stockinfo { OUString m_sStock; int m_nSize; stockinfo() : m_nSize(4) {} }; typedef std::map StockMap; struct SizeGroup { std::vector m_aWidgets; stringmap m_aProperties; SizeGroup() {} }; typedef std::map, stringmap> AtkMap; struct ParserState { std::locale m_aResLocale; std::vector m_aGroupMaps; std::vector m_aModelMaps; std::map m_aModels; std::vector m_aTextBufferMaps; std::map m_aTextBuffers; std::vector m_aNumericFormatterAdjustmentMaps; std::vector m_aTimeFormatterAdjustmentMaps; std::vector m_aDateFormatterAdjustmentMaps; std::vector m_aScrollAdjustmentMaps; std::vector m_aSliderAdjustmentMaps; std::map m_aAdjustments; std::vector m_aButtonImageWidgetMaps; StockMap m_aStockMap; std::vector m_aButtonMenuMaps; std::map, VclPtr> m_aRedundantParentWidgets; std::vector m_aSizeGroups; AtkMap m_aAtkInfo; std::vector m_aMnemonicWidgetMaps; std::vector< VclPtr > m_aExpanderWidgets; sal_uInt16 m_nLastToolbarId; sal_uInt16 m_nLastMenuItemId; ParserState(); }; OString m_sID; OString m_sHelpRoot; ResHookProc m_pStringReplace; VclPtr m_pParent; bool m_bToplevelHasDeferredInit; bool m_bToplevelHasDeferredProperties; bool m_bToplevelParentFound; std::unique_ptr m_pParserState; vcl::Window *get_by_name(const OString& sID); void delete_by_name(const OString& sID); class sortIntoBestTabTraversalOrder { public: sortIntoBestTabTraversalOrder(VclBuilder *pBuilder) : m_pBuilder(pBuilder) {} bool operator()(const vcl::Window *pA, const vcl::Window *pB) const; private: VclBuilder *m_pBuilder; }; /// XFrame to be able to extract labels and other properties of the UNO commands (like of .uno:Bold). css::uno::Reference m_xFrame; private: VclPtr insertObject(vcl::Window *pParent, const OString &rClass, const OString &rID, stringmap &rProps, stringmap &rPangoAttributes, stringmap &rAtkProps); VclPtr makeObject(vcl::Window *pParent, const OString &rClass, const OString &rID, stringmap &rVec); void connectNumericFormatterAdjustment(const OString &id, const OUString &rAdjustment); void connectTimeFormatterAdjustment(const OString &id, const OUString &rAdjustment); void connectDateFormatterAdjustment(const OString &id, const OUString &rAdjustment); bool extractGroup(const OString &id, stringmap &rVec); bool extractModel(const OString &id, stringmap &rVec); bool extractBuffer(const OString &id, stringmap &rVec); static bool extractAdjustmentToMap(const OString &id, stringmap &rVec, std::vector& rAdjustmentMap); bool extractButtonImage(const OString &id, stringmap &rMap, bool bRadio); bool extractStock(const OString &id, stringmap &rMap); void extractMnemonicWidget(const OString &id, stringmap &rMap); void handleChild(vcl::Window *pParent, xmlreader::XmlReader &reader); VclPtr handleObject(vcl::Window *pParent, xmlreader::XmlReader &reader); void handlePacking(vcl::Window *pCurrent, vcl::Window *pParent, xmlreader::XmlReader &reader); static std::vector handleStyle(xmlreader::XmlReader &reader, int &nPriority); static OString getStyleClass(xmlreader::XmlReader &reader); void applyPackingProperty(vcl::Window *pCurrent, vcl::Window *pParent, xmlreader::XmlReader &reader); void collectProperty(xmlreader::XmlReader &reader, stringmap &rVec) const; static void collectPangoAttribute(xmlreader::XmlReader &reader, stringmap &rMap); static void collectAtkAttribute(xmlreader::XmlReader &reader, stringmap &rMap); static void collectAccelerator(xmlreader::XmlReader &reader, accelmap &rMap); void insertMenuObject( PopupMenu *pParent, PopupMenu *pSubMenu, const OString &rClass, const OString &rID, stringmap &rProps, accelmap &rAccels); void handleMenuChild(PopupMenu *pParent, xmlreader::XmlReader &reader); void handleMenuObject(PopupMenu *pParent, xmlreader::XmlReader &reader); void handleListStore(xmlreader::XmlReader &reader, const OString &rID); void handleRow(xmlreader::XmlReader &reader, const OString &rID); void handleTabChild(vcl::Window *pParent, xmlreader::XmlReader &reader); void handleMenu(xmlreader::XmlReader &reader, const OString &rID); std::vector handleItems(xmlreader::XmlReader &reader) const; void handleSizeGroup(xmlreader::XmlReader &reader); void handleAtkObject(xmlreader::XmlReader &reader, vcl::Window *pWindow); void handleActionWidget(xmlreader::XmlReader &reader); PackingData get_window_packing_data(const vcl::Window *pWindow) const; void set_window_packing_position(const vcl::Window *pWindow, sal_Int32 nPosition); static vcl::Window* prepareWidgetOwnScrolling(vcl::Window *pParent, WinBits &rWinStyle); void cleanupWidgetOwnScrolling(vcl::Window *pScrollParent, vcl::Window *pWindow, stringmap &rMap); void set_response(const OString& sID, short nResponse); OString get_by_window(const vcl::Window *pWindow) const; void delete_by_window(vcl::Window *pWindow); }; namespace BuilderUtils { //apply the properties of rProps to pWindow VCL_DLLPUBLIC void set_properties(vcl::Window *pWindow, const VclBuilder::stringmap &rProps); //Convert _ gtk markup to ~ vcl markup VCL_DLLPUBLIC OUString convertMnemonicMarkup(const OUString &rIn); VCL_DLLPUBLIC OUString extractCustomProperty(VclBuilder::stringmap &rMap); VCL_DLLPUBLIC FieldUnit detectUnit(OUString const&); VCL_DLLPUBLIC bool extractDropdown(VclBuilder::stringmap &rMap); //add a default value of 25 width-chars to a map if width-chars not set VCL_DLLPUBLIC void ensureDefaultWidthChars(VclBuilder::stringmap &rMap); //Helpers to retrofit all the existing code to the builder VCL_DLLPUBLIC void reorderWithinParent(std::vector< vcl::Window*>& rChilds, bool bIsButtonBox); VCL_DLLPUBLIC void reorderWithinParent(vcl::Window &rWindow, sal_uInt16 nNewPosition); } template inline T* VclBuilder::get(VclPtr& ret, const OString& sID) { vcl::Window *w = get_by_name(sID); SAL_WARN_IF(!w, "vcl.layout", "widget \"" << sID << "\" not found in .ui"); SAL_WARN_IF(!dynamic_cast(w), "vcl.layout", ".ui widget \"" << sID << "\" needs to correspond to vcl type " << typeid(T).name()); assert(w); assert(dynamic_cast(w)); ret = static_cast(w); return ret.get(); } //sID may not exist, but must be of type T if it does template inline T* VclBuilder::get(const OString& sID) { vcl::Window *w = get_by_name(sID); SAL_WARN_IF(w && !dynamic_cast(w), "vcl.layout", ".ui widget \"" << sID << "\" needs to correspond to vcl type " << typeid(T).name()); assert(!w || dynamic_cast(w)); return static_cast(w); } //helper baseclass to ease retro fitting dialogs/tabpages that load a resource //to load a .ui file instead // //vcl requires the Window Children of a Parent Window to be destroyed before //the Parent Window. VclBuilderContainer owns the VclBuilder which owns the //Children Window. So the VclBuilderContainer dtor must be called before //the Parent Window dtor. // //i.e. class Dialog : public SystemWindow, public VclBuilderContainer //not class Dialog : public VclBuilderContainer, public SystemWindow // //With the new 'dispose' framework, it is necessary to force the builder //dispose before the Window dispose; so a Dialog::dispose() method would //finish: disposeBuilder(); SystemWindow::dispose() to capture this ordering. class VCL_DLLPUBLIC VclBuilderContainer { public: VclBuilderContainer(); virtual ~VclBuilderContainer(); void disposeBuilder(); static OUString getUIRootDir(); bool hasBuilder() const { return m_pUIBuilder != nullptr; } template T* get(VclPtr& ret, const OString& sID) { return m_pUIBuilder->get(ret, sID); } template T* get(const OString & sID) { return m_pUIBuilder->get(sID); } PopupMenu* get_menu(const OString & sID) { return m_pUIBuilder->get_menu(sID); } void setDeferredProperties() { if (!m_pUIBuilder) return; m_pUIBuilder->setDeferredProperties(); } OString getUIFile() const { if (m_pUIBuilder) { return m_pUIBuilder->getUIFile(); } return OString(); } protected: std::unique_ptr m_pUIBuilder; }; /* * @return true if rValue is "True", "true", "1", etc. */ bool VCL_DLLPUBLIC toBool(const OUString &rValue); #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */ lue='feature/firebird-sdbc'>feature/firebird-sdbc LibreOffice 核心代码仓库文档基金会
summaryrefslogtreecommitdiff
AgeCommit message (Expand)Author
2024-05-14loplugin:ostr in svlNoel Grandin
2021-06-09Add an SvAddressParser unit testStephan Bergmann