Mercurial > projects > dwt-addons
diff dwtx/jface/text/IInformationControlExtension3.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 diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwtx/jface/text/IInformationControlExtension3.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,85 @@ +/******************************************************************************* + * Copyright (c) 2000, 2008 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.IInformationControlExtension3; + +import dwt.dwthelper.utils; + +import dwt.graphics.Rectangle; + + +/** + * Extension interface for {@link dwtx.jface.text.IInformationControl}. + * Adds API which allows to get this information control's bounds and introduces + * the concept of persistent size and location by introducing predicates for + * whether the information control supports restoring of size and location. + * <p> + * Note: An information control which implements this interface can ignore calls + * to + * {@link dwtx.jface.text.IInformationControl#setSizeConstraints(int, int)} + * or use it as hint for its very first appearance. + * </p> + * + * @see dwtx.jface.text.IInformationControl + * @since 3.0 + */ +public interface IInformationControlExtension3 { + + /** + * Returns a rectangle describing the receiver's size and location + * relative to its parent (or its display if its parent is null). + * <p> + * Note: If the receiver is already disposed then this methods must + * return the last valid location and size. + * </p> + * + * @return the receiver's bounding rectangle + */ + Rectangle getBounds(); + + /** + * Computes the trim for this control. The trim is the space around the + * information control's actual content area. It includes all borders of the + * control and other static content placed around the content area (e.g. a + * toolbar). + * + * @return The receiver's trim. <code>x</code> and <code>y</code> denote + * the upper left corner of the trimming relative to this control's + * location i.e. this will most likely be negative values. + * <code>width</code> and <code>height</code> represent the + * border sizes (the sum of the horizontal and vertical trimmings, + * respectively). + */ + Rectangle computeTrim(); + + /** + * Tells whether this control allows to restore the previously + * used size. + * <p> + * Note: This is not a static property - it can change during the + * lifetime of this control.</p> + * + * @return <code>true</code> if restoring size is supported + */ + bool restoresSize(); + + /** + * Tells whether this control allows to restore the previously + * used location. + * <p> + * Note: This is not a static property - it can change during the + * lifetime of this control.</p> + * + * @return <code>true</code> if restoring location is supported + */ + bool restoresLocation(); +}