xref: /aoo42x/main/vcl/inc/dbggui.hxx (revision ebfcd9af)
1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef _SV_DBGGUI_HXX
25 #define _SV_DBGGUI_HXX
26 
27 #include <vcl/sv.h>
28 
29 // ------------
30 // - DBG_UITL -
31 // ------------
32 
33 #ifdef DBG_UTIL
34 
35 class Window;
36 class XubString;
37 
38 void DbgGUIInit();
39 void DbgGUIDeInit();
40 void DbgGUIStart();
41 void DbgDialogTest( Window* pWindow );
42 
43 /** registers a named user-defined channel for emitting the diagnostic messages
44     @return
45         a unique number for this channel, which can be used for ->DbgData::nErrorOut,
46         ->DbgData::nWarningOut and ->DbgData::nTraceOut
47     @see DBG_OUT_USER_CHANNEL_0
48 */
49 sal_uInt16 DbgRegisterNamedUserChannel( const XubString& _rChannelUIName, DbgPrintLine pProc );
50 
51 #define DBGGUI_INIT()           DbgGUIInit()
52 #define DBGGUI_DEINIT()         DbgGUIDeInit()
53 #define DBGGUI_START()          DbgGUIStart()
54 
55 #define DBG_DIALOGTEST( pWindow )                   \
56     if ( DbgIsDialog() )                            \
57         DbgDialogTest( pWindow );
58 
59 #else
60 
61 
62 #define DBGGUI_INIT()
63 #define DBGGUI_DEINIT()
64 #define DBGGUI_START()
65 
66 #define DBG_DIALOGTEST( pWindow )
67 
68 #endif
69 
70 #endif  // _SV_DBGGUI_HXX
71