summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorChris Sherlock <chris.sherlock79@gmail.com>2017-04-24 02:17:53 +1000
committerChris Sherlock <chris.sherlock79@gmail.com>2017-04-27 08:25:20 +0200
commit0c4d2767742d3a86a392eb328762d92050527cad (patch)
tree48d003af0b485970fb7fd2f736062674294cf258 /include
parent7df07fabe481f2bcf8b780d05739b3406b0adf39 (diff)
vcl: move doxygen comment to header
Change-Id: I486843fc4b9da3fc5fc161e90768b0443530071a Reviewed-on: https://gerrit.libreoffice.org/36859 Tested-by: Chris Sherlock <chris.sherlock79@gmail.com> Reviewed-by: Chris Sherlock <chris.sherlock79@gmail.com>
Diffstat (limited to 'include')
-rw-r--r--include/vcl/errinf.hxx15
1 files changed, 15 insertions, 0 deletions
diff --git a/include/vcl/errinf.hxx b/include/vcl/errinf.hxx
index e8bb5127da20..476bbb52ac41 100644
--- a/include/vcl/errinf.hxx
+++ b/include/vcl/errinf.hxx
@@ -118,6 +118,21 @@ public:
ErrorHandler();
virtual ~ErrorHandler();
+ /** Handles an error.
+
+ If nFlags is not set, the DynamicErrorInfo flags or the
+ resource flags will be used. Thus the order is:
+
+ 1. nFlags,
+ 2. Resource Flags
+ 3. Dynamic Flags
+ 4. Default ButtonsOk, MessageError
+
+ @param nErrCodeId error id
+ @param nFlags error flags.
+
+ @return what sort of dialog to use, with what buttons
+ */
static DialogMask HandleError(sal_uInt32 nId, DialogMask nMask = DialogMask::MAX);
static bool GetErrorString(sal_uInt32 nId, OUString& rStr);