LibreOffice
LibreOffice 6.4 SDK API Reference
XStatusIndicator.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 #ifndef __com_sun_star_task_XStatusIndicator_idl__
20 #define __com_sun_star_task_XStatusIndicator_idl__
21 
23 
24 
25  module com { module sun { module star { module task {
26 
37 {
56  void start(
57  [in] string Text,
58  [in] long Range);
59 
72  void end();
73 
85  void setText( [in] string Text );
86 
99  void setValue( [in] long Value );
100 
108  void reset();
109 };
110 
111 }; }; }; };
112 
113 #endif
114 
115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
com::sun::star::task::XStatusIndicator::reset
void reset()
clear progress value and description
com::sun::star::task::XStatusIndicator::start
void start([in] string Text, [in] long Range)
initialize and start the progress
com::sun::star::task::XStatusIndicator::setValue
void setValue([in] long Value)
update progress value
com::sun::star::task::XStatusIndicator::end
void end()
stop the progress
com::sun::star::task::XStatusIndicator
controls a status indicator which displays progress of longer actions to the user
Definition: XStatusIndicator.idl:37
com
Definition: Ambiguous.idl:22
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::task::XStatusIndicator::setText
void setText([in] string Text)
update progress description