offapi/com/sun/star/table/XCellCursor.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 table {
  22
  23
  24 /** provides methods to control the position of a cell cursor.
  25
  26     @see com::sun::star::table::CellCursor
  27  */
  28 published interface XCellCursor: com::sun::star::table::XCellRange
  29 {
  30
  31     /** points the cursor to a single cell which is the beginning of a
  32         contiguous series of (filled) cells.
  33      */
  34     void gotoStart();
  35
  36
  37     /** points the cursor to a single cell which is the end of a contiguous
  38         series of (filled) cells.
  39      */
  40     void gotoEnd();
  41
  42
  43     /** points the cursor to the next unprotected cell.
  44
  45         <p>If the sheet is not protected, this is the next cell to the
  46         right.</p>
  47      */
  48     void gotoNext();
  49
  50
  51     /** points the cursor to the previous unprotected cell.
  52
  53         <p>If the sheet is not protected, this is the next cell to the
  54         left.</p>
  55      */
  56     void gotoPrevious();
  57
  58
  59     /** moves the origin of the cursor relative to the current position.
  60
  61         @param nColumnOffset
  62             is the count of columns to move. A negative value moves the
  63             cursor to the left.
  64
  65         @param nRowOffset
  66             is the count of rows to move. A negative value moves the
  67             cursor to the top.
  68      */
  69     void gotoOffset( [in] long nColumnOffset, [in] long nRowOffset );
  70
  71 };
  72
  73
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */