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