xref: /aoo41x/main/vcl/inc/dbggui.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef _SV_DBGGUI_HXX
29 #define _SV_DBGGUI_HXX
30 
31 #include <vcl/sv.h>
32 
33 // ------------
34 // - DBG_UITL -
35 // ------------
36 
37 #ifdef DBG_UTIL
38 
39 class Window;
40 class XubString;
41 
42 void DbgGUIInit();
43 void DbgGUIDeInit();
44 void DbgGUIStart();
45 void DbgDialogTest( Window* pWindow );
46 
47 /** registers a named user-defined channel for emitting the diagnostic messages
48     @return
49         a unique number for this channel, which can be used for ->DbgData::nErrorOut,
50         ->DbgData::nWarningOut and ->DbgData::nTraceOut
51     @see DBG_OUT_USER_CHANNEL_0
52 */
53 sal_uInt16 DbgRegisterNamedUserChannel( const XubString& _rChannelUIName, DbgPrintLine pProc );
54 
55 #define DBGGUI_INIT()           DbgGUIInit()
56 #define DBGGUI_DEINIT()         DbgGUIDeInit()
57 #define DBGGUI_START()          DbgGUIStart()
58 
59 #define DBG_DIALOGTEST( pWindow )                   \
60     if ( DbgIsDialog() )                            \
61         DbgDialogTest( pWindow );
62 
63 #else
64 
65 
66 #define DBGGUI_INIT()
67 #define DBGGUI_DEINIT()
68 #define DBGGUI_START()
69 
70 #define DBG_DIALOGTEST( pWindow )
71 
72 #endif
73 
74 #endif  // _SV_DBGGUI_HXX
75