LibreOffice LibreOffice 26.2 SDK API Reference

ItemDescriptor.idl
Go to the documentation of this file.
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 */
19
20
21module com { module sun { module star { module ui {
22
38service ItemDescriptor
39{
43 [property] short Type;
44
47 [property] string Label;
48
51 [property] string CommandURL;
52
55 [property] string HelpURL;
56
61 [optional, property] short Style;
62
66 [optional, property] short Offset;
67
71 [optional, property] com::sun::star::container::XIndexAccess ItemDescriptorContainer;
72
76 [optional, property] boolean IsVisible;
77
81 [optional, property] short Width;
82};
83
84}; }; }; };
85
86/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::XIndexAccess
provides access to the elements of a collection through an index.
Definition: XIndexAccess.idl:32
com
Definition: Ambiguous.idl:20
com::sun::star::ui::ItemDescriptor
describes a user interface item that is part of a user interface element.
Definition: ItemDescriptor.idl:39
com::sun::star::ui::ItemDescriptor::Label
string Label
the text of the user interface item.
Definition: ItemDescriptor.idl:47
com::sun::star::ui::ItemDescriptor::ItemDescriptorContainer
com::sun::star::container::XIndexAccess ItemDescriptorContainer
specifies an optional sub container.
Definition: ItemDescriptor.idl:71
com::sun::star::ui::ItemDescriptor::Style
short Style
different styles which influence the appearance of the item and its behavior.
Definition: ItemDescriptor.idl:61
com::sun::star::ui::ItemDescriptor::CommandURL
string CommandURL
contains the command URL which specifies which action should be accomplished.
Definition: ItemDescriptor.idl:51
com::sun::star::ui::ItemDescriptor::HelpURL
string HelpURL
contains the a URL that points to a help text.
Definition: ItemDescriptor.idl:55
com::sun::star::ui::ItemDescriptor::Width
short Width
specifies a pixel width for this item inside the user interface element.
Definition: ItemDescriptor.idl:81
com::sun::star::ui::ItemDescriptor::IsVisible
boolean IsVisible
specifies if this item is visible or not.
Definition: ItemDescriptor.idl:76
com::sun::star::ui::ItemDescriptor::Type
short Type
specifies which type this item descriptor belongs to.
Definition: ItemDescriptor.idl:43
com::sun::star::ui::ItemDescriptor::Offset
short Offset
specifies the pixel distance by which the text of the item is shifted on the x-axis.
Definition: ItemDescriptor.idl:66