offapi/com/sun/star/frame/DispatchStatement.idl

   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_frame_DispatchStatement_idl__
  20 #define __com_sun_star_frame_DispatchStatement_idl__
  21
  22 #include <com/sun/star/beans/PropertyValue.idl>
  23
  24
  25  module com {  module sun {  module star {  module frame {
  26
  27 /** represents a dispatch statement from a recorded macro
  28
  29     @since OOo 1.1.2
  30  */
  31 published struct DispatchStatement
  32 {
  33         /** specifies the dispatch command
  34
  35             <p>
  36             That means the <var>URL</var> parameter of a corresponding XDispatchProvider::queryDispatch() request.
  37             </p>
  38          */
  39     string aCommand;
  40
  41
  42         /** specifies the frame target
  43
  44             <p>
  45             That means the <var>TargetFrameName</var> parameter of a corresponding XDispatchProvider::queryDispatch() request.
  46             </p>
  47          */
  48         string aTarget;
  49
  50         /** specifies the dispatch command arguments
  51
  52             <p>
  53             That means the <var>Arguments</var> parameter of a corresponding XDispatch::dispatch() request.
  54             </p>
  55          */
  56         sequence < com::sun::star::beans::PropertyValue > aArgs;
  57
  58         /** specifies the optional search flags
  59             <p>
  60             That means the <var>SearchFlags</var> parameter of a corresponding XDispatchProvider::queryDispatch() request.
  61             </p>
  62          */
  63         long nFlags;
  64
  65         /** specifies if this statement should be recorded as commented out or not
  66
  67             @see XDispatchRecorder::recordDispatchAsComment()
  68          */
  69         boolean bIsComment;
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */