/******************************************************************************* * Copyright (c) 2000, 2011 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 *******************************************************************************/ package org.eclipse.swt.widgets; import org.eclipse.swt.*; import org.eclipse.swt.internal.*; import org.eclipse.swt.internal.gtk.*; import org.eclipse.swt.graphics.*; /** * Instances of this class allow the user to select a font * from all available fonts in the system. *
* IMPORTANT: This class is not intended to be subclassed. *
* * @see SWT Example: ControlExample, Dialog tab * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class FontDialog extends Dialog { FontData fontData; RGB rgb; /** * Constructs a new instance of this class given only its parent. * * @param parent a shell which will be the parent of the new instance * * @exception IllegalArgumentException
* The style value is either one of the style constants defined in
* class SWT
which is applicable to instances of this
* class, or must be built by bitwise OR'ing together
* (that is, using the int
"|" operator) two or more
* of those SWT
style constants. The class description
* lists the style constants that are applicable to the class.
* Style bits are also inherited from superclasses.
*
true
if the dialog's effects selection controls
* are visible, and false
otherwise.
* * If the platform's font dialog does not have any effects selection controls, * then this method always returns false. *
* * @returntrue
if the dialog's effects selection controls
* are visible and false
otherwise
*
* @since 3.8
*/
public boolean getEffectsVisible () {
// The GTK FontDialog does not have any effects selection controls.
return false;
}
/**
* Returns a FontData object describing the font that was
* selected in the dialog, or null if none is available.
*
* @return the FontData for the selected font, or null
* @deprecated use #getFontList ()
*/
public FontData getFontData () {
return fontData;
}
/**
* Returns a FontData set describing the font that was
* selected in the dialog, or null if none is available.
*
* @return the FontData for the selected font, or null
* @since 2.1.1
*/
public FontData [] getFontList () {
if (fontData == null) return null;
FontData [] result = new FontData [1];
result [0] = fontData;
return result;
}
/**
* Returns an RGB describing the color that was selected
* in the dialog, or null if none is available.
*
* @return the RGB value for the selected color, or null
*
* @see PaletteData#getRGBs
*
* @since 2.1
*/
public RGB getRGB () {
return rgb;
}
/**
* Makes the dialog visible and brings it to the front
* of the display.
*
* @return a FontData object describing the font that was selected,
* or null if the dialog was cancelled or an error occurred
*
* @exception SWTException true
, and invisible otherwise.
* * By default the effects selection controls are displayed if the * platform font dialog supports effects selection. *
* * @param visible whether or not the dialog will show the effects selection controls * * @since 3.8 */ public void setEffectsVisible(boolean visible) { // The GTK FontDialog does not have any effects selection controls. } /** * Sets a FontData object describing the font to be * selected by default in the dialog, or null to let * the platform choose one. * * @param fontData the FontData to use initially, or null * @deprecated use #setFontList (FontData []) */ public void setFontData (FontData fontData) { this.fontData = fontData; } /** * Sets the set of FontData objects describing the font to * be selected by default in the dialog, or null to let * the platform choose one. * * @param fontData the set of FontData objects to use initially, or null * to let the platform select a default when open() is called * * @see Font#getFontData * * @since 2.1.1 */ public void setFontList (FontData [] fontData) { if (fontData != null && fontData.length > 0) { this.fontData = fontData [0]; } else { this.fontData = null; } } /** * Sets the RGB describing the color to be selected by default * in the dialog, or null to let the platform choose one. * * @param rgb the RGB value to use initially, or null to let * the platform select a default when open() is called * * @see PaletteData#getRGBs * * @since 2.1 */ public void setRGB (RGB rgb) { this.rgb = rgb; } }