view dwtx/jface/text/source/ILineRange.d @ 129:eb30df5ca28b

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwtx.jface.text.source.ILineRange;

import dwt.dwthelper.utils;

/**
 * Describes a range of lines.
 * <p>
 * Note that the number of lines is 1-based, e.g. <code>getStartLine() + getNumberOfLines()</code>
 * computes the first line <em>after</em> the range, and a range with
 * <code>getNumberOfLines() is 0</code> is empty.
 * </p>
 * 
 * @since 3.0
 */
public interface ILineRange {

    /**
     * Returns the start line of this line range or <code>-1</code>.
     *
     * @return the start line of this line range or <code>-1</code> if this line range is invalid.
     */
    int getStartLine();

    /**
     * Returns the number of lines of this line range or <code>-1</code>.
     *
     * @return the number of lines in this line range or <code>-1</code> if this line range is invalid.
     */
    int getNumberOfLines();
}