diff options
author | Chris Sherlock <chris.sherlock79@gmail.com> | 2014-02-04 19:55:39 +0000 |
---|---|---|
committer | Caolán McNamara <caolanm@redhat.com> | 2014-02-05 09:14:53 +0000 |
commit | 51a68b4992c6eb7015d838d1fdf9fc84ec0fa5d2 (patch) | |
tree | 3fe907e6cdefffc48000197ec7f94d9f8c104858 /include/vcl/builder.hxx | |
parent | 651756a5f40b6340518e97a31113cb59438ab40d (diff) |
Doxygen warnings corrected
* Doxygen spits out a lot of warnings about not being able to find
match function signatures, etc. This is because in some headers we
have a using namespace statement, in others it gets confused between
::Window and Window (!).
* Wrong use of tags:
+ Lots of @seealso - should be @see
+ Wrong usage of @overload - corrected with the right function
signature
+ HTML tags that doxygen doesn't recognize removed
Change-Id: I1c2eed941619b8764dbfcfc5ab38027518cdf261
Diffstat (limited to 'include/vcl/builder.hxx')
-rw-r--r-- | include/vcl/builder.hxx | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/include/vcl/builder.hxx b/include/vcl/builder.hxx index 942430674c68..68392c18cfe5 100644 --- a/include/vcl/builder.hxx +++ b/include/vcl/builder.hxx @@ -42,7 +42,7 @@ class VCL_DLLPUBLIC VclBuilder: private boost::noncopyable { public: typedef std::map<OString, OString> stringmap; - typedef ::Window* (*customMakeWidget)(::Window *pParent, stringmap &rVec); + typedef Window* (*customMakeWidget)(Window *pParent, stringmap &rVec); private: typedef boost::ptr_map<OUString, osl::Module> ModuleMap; //We store these until the builder is deleted, that way we can use the @@ -71,10 +71,10 @@ private: struct WinAndId { OString m_sID; - ::Window *m_pWindow; + Window *m_pWindow; short m_nResponseId; PackingData m_aPackingData; - WinAndId(const OString &rId, ::Window *pWindow, bool bVertical) + WinAndId(const OString &rId, Window *pWindow, bool bVertical) : m_sID(rId) , m_pWindow(pWindow) , m_nResponseId(RET_CANCEL) @@ -182,7 +182,7 @@ private: } }; - typedef std::map< ::Window*, stringmap> AtkMap; + typedef std::map< Window*, stringmap> AtkMap; struct ParserState { @@ -207,7 +207,7 @@ private: Translations m_aTranslations; - std::map< ::Window*, ::Window*> m_aRedundantParentWidgets; + std::map< Window*, Window*> m_aRedundantParentWidgets; std::vector<SizeGroup> m_aSizeGroups; @@ -224,17 +224,17 @@ private: OString m_sID; OString m_sHelpRoot; ResHookProc m_pStringReplace; - ::Window *m_pParent; + Window *m_pParent; bool m_bToplevelHasDeferredInit; bool m_bToplevelHasDeferredProperties; bool m_bToplevelParentFound; ParserState *m_pParserState; - ::Window *get_by_name(OString sID); + Window *get_by_name(OString sID); void delete_by_name(OString sID); class sortIntoBestTabTraversalOrder - : public std::binary_function<const ::Window*, const ::Window*, bool> + : public std::binary_function<const Window*, const Window*, bool> { VclBuilder *m_pBuilder; public: @@ -242,22 +242,22 @@ private: : m_pBuilder(pBuilder) { } - bool operator()(const ::Window *pA, const ::Window *pB) const; + bool operator()(const Window *pA, const Window *pB) const; }; /// XFrame to be able to extract labels and other properties of the UNO commands (like of .uno:Bold). css::uno::Reference<css::frame::XFrame> m_xFrame; public: - VclBuilder(::Window *pParent, OUString sUIRootDir, OUString sUIFile, + VclBuilder(Window *pParent, OUString sUIRootDir, OUString sUIFile, OString sID = OString(), const com::sun::star::uno::Reference<com::sun::star::frame::XFrame> &rFrame = com::sun::star::uno::Reference<com::sun::star::frame::XFrame>()); ~VclBuilder(); - ::Window *get_widget_root(); + Window *get_widget_root(); //sID must exist and be of type T template <typename T> T* get(T*& ret, OString sID) { - ::Window *w = get_by_name(sID); + Window *w = get_by_name(sID); SAL_WARN_IF(!w, "vcl.layout", "widget \"" << sID.getStr() << "\" not found in .ui"); SAL_WARN_IF(!dynamic_cast<T*>(w), "vcl.layout", ".ui widget \"" << sID.getStr() << "\" needs to correspond to vcl type " << typeid(T).name()); @@ -273,9 +273,9 @@ public: return ret; } //sID may not exist, but must be of type T if it does - template <typename T /*= ::Window if we had c++11*/> T* get(OString sID) + template <typename T /*= Window if we had c++11*/> T* get(OString sID) { - ::Window *w = get_by_name(sID); + Window *w = get_by_name(sID); SAL_WARN_IF(w && !dynamic_cast<T*>(w), "vcl.layout", ".ui widget \"" << sID.getStr() << "\" needs to correspond to vcl type " << typeid(T).name()); assert(!w || dynamic_cast<T*>(w)); @@ -285,13 +285,13 @@ public: PopupMenu* get_menu(OString sID); //given an sID return the response value for that widget - short get_response(const ::Window *pWindow) const; + short get_response(const Window *pWindow) const; - OString get_by_window(const ::Window *pWindow) const; - void delete_by_window(const ::Window *pWindow); + OString get_by_window(const Window *pWindow) const; + void delete_by_window(const Window *pWindow); //apply the properties of rProps to pWindow - static void set_properties(::Window *pWindow, const stringmap &rProps); + static void set_properties(Window *pWindow, const stringmap &rProps); //Convert _ gtk markup to ~ vcl markup static OString convertMnemonicMarkup(const OString &rIn); @@ -310,17 +310,17 @@ public: void setDeferredProperties(); //Helpers to retrofit all the existing code to the builder - static void reorderWithinParent(std::vector< ::Window*>& rChilds, bool bIsButtonBox); - static void reorderWithinParent(::Window &rWindow, sal_uInt16 nNewPosition); + static void reorderWithinParent(std::vector< Window*>& rChilds, bool bIsButtonBox); + static void reorderWithinParent(Window &rWindow, sal_uInt16 nNewPosition); css::uno::Reference<css::frame::XFrame> getFrame() { return m_xFrame; } private: - ::Window *insertObject(::Window *pParent, + Window *insertObject(Window *pParent, const OString &rClass, const OString &rID, stringmap &rProps, stringmap &rPangoAttributes, stringmap &rAtkProps, std::vector<OString> &rItems); - ::Window *makeObject(::Window *pParent, + Window *makeObject(Window *pParent, const OString &rClass, const OString &rID, stringmap &rVec, const std::vector<OString> &rItems); @@ -338,10 +338,10 @@ private: void handleTranslations(xmlreader::XmlReader &reader); - void handleChild(::Window *pParent, xmlreader::XmlReader &reader); - ::Window* handleObject(::Window *pParent, xmlreader::XmlReader &reader); - void handlePacking(::Window *pCurrent, xmlreader::XmlReader &reader); - void applyPackingProperty(::Window *pCurrent, xmlreader::XmlReader &reader); + void handleChild(Window *pParent, xmlreader::XmlReader &reader); + Window* handleObject(Window *pParent, xmlreader::XmlReader &reader); + void handlePacking(Window *pCurrent, xmlreader::XmlReader &reader); + void applyPackingProperty(Window *pCurrent, xmlreader::XmlReader &reader); void collectProperty(xmlreader::XmlReader &reader, const OString &rID, stringmap &rVec); void collectPangoAttribute(xmlreader::XmlReader &reader, stringmap &rMap); void collectAtkAttribute(xmlreader::XmlReader &reader, stringmap &rMap); @@ -356,21 +356,21 @@ private: void handleRow(xmlreader::XmlReader &reader, const OString &rID, sal_Int32 nRowIndex); void handleAdjustment(const OString &rID, stringmap &rProperties); void handleTextBuffer(const OString &rID, stringmap &rProperties); - void handleTabChild(::Window *pParent, xmlreader::XmlReader &reader); + void handleTabChild(Window *pParent, xmlreader::XmlReader &reader); void handleMenu(xmlreader::XmlReader &reader, const OString &rID); std::vector<OString> handleItems(xmlreader::XmlReader &reader, const OString &rID); void handleSizeGroup(xmlreader::XmlReader &reader, const OString &rID); - void handleAtkObject(xmlreader::XmlReader &reader, const OString &rID, ::Window *pWindow); + void handleAtkObject(xmlreader::XmlReader &reader, const OString &rID, Window *pWindow); void handleActionWidget(xmlreader::XmlReader &reader); - PackingData get_window_packing_data(const ::Window *pWindow) const; - void set_window_packing_position(const ::Window *pWindow, sal_Int32 nPosition); + PackingData get_window_packing_data(const Window *pWindow) const; + void set_window_packing_position(const Window *pWindow, sal_Int32 nPosition); - ::Window* prepareWidgetOwnScrolling(::Window *pParent, WinBits &rWinStyle); - void cleanupWidgetOwnScrolling(::Window *pScrollParent, ::Window *pWindow, stringmap &rMap); + Window* prepareWidgetOwnScrolling(Window *pParent, WinBits &rWinStyle); + void cleanupWidgetOwnScrolling(Window *pScrollParent, Window *pWindow, stringmap &rMap); void set_response(OString sID, short nResponse); }; @@ -401,7 +401,7 @@ public: { return m_pUIBuilder->get<T>(ret, sID); } - template <typename T /*= ::Window if we had c++11*/> T* get(OString sID) + template <typename T /*= Window if we had c++11*/> T* get(OString sID) { return m_pUIBuilder->get<T>(sID); } |