| blob | a3306ae0ac254ede4d6424a4f217b5438073a343 |
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
22 /** This interface is a collection of functions that were necessary to
23 implement larger parts of the presenter screen as extension. The
24 methods of this interface give access to services that could only be
25 implemented in the Office core, not in an extension.
27 <p>As the presenter screen is no extension any more, this hack can go again;
28 it just needs clean-up.</p>
29 */
30 interface XPresenterHelper
31 {
32 /** Create a new window as child window of the given parent window.
33 @param xParentWindow
34 The parent window of the new window.
35 @param bCreateSystemChildWindow
36 When `TRUE` then the new window will be a system window that,
37 in the context of the presenter screen, can not be painted over
38 by other windows that lie behind it.
39 @param bInitiallyVisible
40 When `TRUE` the new window will be visible from the start,
41 i.e. a window listener will not receive a windowShown signal.
42 @param bEnableChildTransparentMode
43 When `TRUE` the parent window is painted behind its child
44 windows. This is one half of allowing child windows to be
45 transparent.
46 @param bEnableParentClip
47 When `TRUE` then the parent window is not clipped where its
48 child windows are painted. This is the other half of allowing
49 child windows to be transparent.
50 */
58 /** Create a new canvas for the given window. The new canvas is a
59 wrapper around the given shared canvas. The wrapper only modifies
60 the origin in all output and clipping methods.
61 @param xUpdateCanvas
62 This canvas is used to call updateScreen() on. May be `NULL`
63 @param xUpdateWindow
64 The window that belongs to the update canvas. May also be
65 `NULL` (is expected to b `NULL` whenever xUpdateCanvas is.)
66 @param xSharedCanvas
67 The canvas that is shared by the wrapper.
68 @param xSharedWindow
69 The window of the shared canvas. This is used to determine the
70 proper offset.
71 @param xWindow
72 The canvas is created for this window. Must not be `NULL`
73 */
81 /** Create a new canvas for the given window.
82 @param xWindow
83 The canvas is created for this window. Must not be `NULL`
84 @param nRequestedCanvasFeatureList
85 List of requested features that the new canvas should (has to)
86 provide. Use only values from the CanvasFeature
87 constants group.
88 @param sOptionalCanvasServiceName
89 When an explicit service name is given then a new object of this
90 service is created. This service name lets the caller select a
91 specific canvas implementation, e.g. with or without hardware
92 acceleration.
93 */
99 /** Move the specified window to the top of its stacking order. As a
100 result the window will be painted over all its overlapping
101 siblings.
102 @param xWindow
103 This window will be moved to the top of its stacking order.
104 */
108 /** Load a bitmap with a given ID.
109 @param id
110 The ID of the bitmap.
111 @param xCanvas
112 The bitmap is created to be compatible, and possibly optimized,
113 for this canvas.
114 */
119 /** Capture the mouse so that no other window will receive mouse events.
120 Note that this is a potentially dangerous method. Not calling
121 releaseMouse eventually can lead to an unresponsive application.
122 @param xWindow
123 The window for which mouse events will be notified even when the
124 mouse pointer moves outside the window or over other windows.
125 */
129 /** Release a previously captured mouse.
130 @param xWindow
131 The window from which the mouse will be released.
132 */
136 /** Return the bounding box of the given child window relative to the
137 direct or indirect parent window.
138 */
142 };
147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */