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