diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
commit | 267c6f2ac71f92999e969232431ba04678e7437e (patch) | |
tree | 358c9467650e1d0a1d7227a21dac2e3d08b622b2 /offapi/com/sun/star/script/browse | |
parent | Initial commit. (diff) | |
download | libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.tar.xz libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.zip |
Adding upstream version 4:24.2.0.upstream/4%24.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/script/browse')
7 files changed, 306 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/browse/BrowseNode.idl b/offapi/com/sun/star/script/browse/BrowseNode.idl new file mode 100644 index 0000000000..09f0c38bbe --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNode.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ + +module com { + module sun { + module star { + module script { + module browse { + +/** + This service provides access to the Macros and Macro containers via the + XBrowseNode interface. XInvocation is an optional interface that is used + to execute macros, or to create/delete/rename macros or macro containers. + + @since OOo 2.0 +*/ +service BrowseNode +{ + interface ::com::sun::star::script::browse::XBrowseNode; + [ optional ] interface ::com::sun::star::script::XInvocation; +}; + + }; + }; + }; + }; +}; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/script/browse/BrowseNodeFactory.idl b/offapi/com/sun/star/script/browse/BrowseNodeFactory.idl new file mode 100644 index 0000000000..07ce14b0b3 --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNodeFactory.idl @@ -0,0 +1,35 @@ +/* -*- 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 . + */ + +module com { module sun { module star { module script { module browse { + +/** + This service is used to create Root XBrowseNodes. + + @since OOo 2.0 + @deprecated use the singleton theBrowseNodeFactory +*/ +service BrowseNodeFactory +{ + interface XBrowseNodeFactory; +}; + +}; }; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl b/offapi/com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl new file mode 100644 index 0000000000..3f62f50732 --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNodeFactoryViewTypes.idl @@ -0,0 +1,40 @@ +/* -*- 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 . + */ + + +module com { module sun { module star { module script { module browse { +/** + These constants define the three different types of views available from + BrowseNodeFactory. +*/ +constants BrowseNodeFactoryViewTypes +{ + /** + Indicates view is a script selector + */ + const short MACROSELECTOR = 0; + /** + Indicates view is script organizer + */ + const short MACROORGANIZER = 1; +}; + +}; }; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/script/browse/BrowseNodeTypes.idl b/offapi/com/sun/star/script/browse/BrowseNodeTypes.idl new file mode 100644 index 0000000000..bbc8a6eb2e --- /dev/null +++ b/offapi/com/sun/star/script/browse/BrowseNodeTypes.idl @@ -0,0 +1,45 @@ +/* -*- 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 . + */ + + +module com { module sun { module star { module script { module browse { +/** + These constants define the three different types of nodes in the BrowseNode + hierarchy. +*/ +constants BrowseNodeTypes +{ + /** + Indicates node is a script + */ + const short SCRIPT = 0; + /** + Indicates node is a container + */ + const short CONTAINER = 1; + /** + Indicates node is root of the tree. + */ + const short ROOT = 2; + +}; + +}; }; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/script/browse/XBrowseNode.idl b/offapi/com/sun/star/script/browse/XBrowseNode.idl new file mode 100644 index 0000000000..4321702f3a --- /dev/null +++ b/offapi/com/sun/star/script/browse/XBrowseNode.idl @@ -0,0 +1,64 @@ +/* -*- 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 . + */ + +module com { module sun { module star { module script { module browse { +/** + This interface represents a node in the hierarchy used to browse + available scripts. + Objects implementing this interface are expected to also implement + com.sun.star.beans.XPropertySet and, optionally, + com.sun.star.script.XInvocation (see the Developer's Guide for + more details). +*/ +interface XBrowseNode : ::com::sun::star::uno::XInterface +{ + /** + Get the name of the node + + @return + The `string` name of this node + */ + string getName(); + + /** + Get the children of this node + + @returns + ::com::sun::star::script::browse::XBrowseNode sequence of child nodes + */ + sequence < XBrowseNode > getChildNodes(); + + /** + Indicates if this node contains any children + + @returns + ` boolean ` true if there are child nodes. + */ + boolean hasChildNodes(); + + /** the type of the node. + @returns A `short` representing the type of this node. + */ + short getType(); + +}; + +}; }; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/script/browse/XBrowseNodeFactory.idl b/offapi/com/sun/star/script/browse/XBrowseNodeFactory.idl new file mode 100644 index 0000000000..d6f8fcf38c --- /dev/null +++ b/offapi/com/sun/star/script/browse/XBrowseNodeFactory.idl @@ -0,0 +1,41 @@ +/* -*- 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 . + */ + + +module com { module sun { module star { module script { module browse { + +/** + This interface provides a factory for obtaining objects implementing the + XBrowseNode interface. +*/ +interface XBrowseNodeFactory : ::com::sun::star::uno::XInterface { + + /** a factory method for the creation of XBrowseNodes + ( view ) ::com::sun::star::script::browse::BrowseNodeFactoryViewTypes specifies the type of view to be returned + + @returns + an object implementing ::com::sun::star::script::browse::XBrowseNode + + */ + com::sun::star::script::browse::XBrowseNode createView( [in] short viewType ); +}; + +}; }; }; }; }; // com::sun::star::script::provider + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ diff --git a/offapi/com/sun/star/script/browse/theBrowseNodeFactory.idl b/offapi/com/sun/star/script/browse/theBrowseNodeFactory.idl new file mode 100644 index 0000000000..dfb331d00c --- /dev/null +++ b/offapi/com/sun/star/script/browse/theBrowseNodeFactory.idl @@ -0,0 +1,36 @@ +/* -*- 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 . + */ + +module com { module sun { module star { module script { module browse { + +/** + The one and only BrowseNodeFactory. + + To get the singleton call getValueByName on the component context + <pre> + /singletons/com.sun.star.script.theBrowseNodeFactory + </pre> + + @since OOo 2.0 +*/ +singleton theBrowseNodeFactory : XBrowseNodeFactory; + +}; }; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |