blob: c8f7578ab59ab876f292794c26221f727207aa67 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_frame_XToolbarController_idl__
#define __com_sun_star_frame_XToolbarController_idl__
#include <com/sun/star/awt/XWindow.idl>
#include <com/sun/star/awt/KeyModifier.idl>
module com { module sun { module star { module frame {
/** is an abstract service for a component which offers a more complex user interface
to users within a toolbar.
<p>
A generic toolbar function is represented as a button which has a state
(enabled,disabled and selected, not selected). A toolbar controller can be added to a
toolbar and provide information or functions with a more sophisticated user interface.<br/>
A typical example for toolbar controller is a font chooser on a toolbar. It provides
all available fonts in a dropdown box and shows the current chosen font.
<p>
@see com::sun::star::frame::XDispatchProvider
@since OOo 2.0
*/
interface XToolbarController : com::sun::star::uno::XInterface
{
/** provides a function to execute the command which is bound to the toolbar controller.
@param KeyModifier
a combination of com::sun::star::awt::KeyModifier value that represent
the current state of the modifier keys.
<p>
This function is usually called by a toolbar implementation when a user clicked on a toolbar button
or pressed enter on the keyboard when the item has the input focus.
</p>
*/
void execute( [in] short KeyModifier );
/** notifies a component that a single click has been made on the toolbar item.
*/
void click();
/** notifies a component that a double click has been made on the toolbar item.
*/
void doubleClick();
/** requests to create a pop-up window for additional functions.
@return
a com::sun::star::awt::XWindow which provides additional functions
to the user. The reference must be empty if component does not want to provide a separate
window.
*/
com::sun::star::awt::XWindow createPopupWindow();
/** requests to create an item window which can be added to the toolbar.
@param Parent
a com::sun::star::awt::XWindow which must be used as a parent
for the requested item window.
@return
a com::sun::star::awt::XWindow which can be added to a toolbar.
The reference must be empty if a component does not want to provide an item window.
*/
com::sun::star::awt::XWindow createItemWindow( [in] com::sun::star::awt::XWindow Parent );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
