Mercurial > projects > dwt-addons
view dwtx/jface/action/ICoolBarManager.d @ 25:ca63e2bea4bf
CoolBarManager
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Thu, 03 Apr 2008 04:50:25 +0200 |
parents | |
children |
line wrap: on
line source
/******************************************************************************* * Copyright (c) 2003, 2006 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.action.ICoolBarManager; import dwtx.jface.action.IContributionManager; import dwtx.jface.action.IToolBarManager; import dwtx.jface.action.IMenuManager; import dwt.widgets.CoolBar; import dwt.dwthelper.utils; /** * The <code>ICoolBarManager</code> interface provides protocol for managing * contributions to a cool bar. A cool bar manager delegates responsibility for * creating child controls to its contribution items by calling * {@link IContributionItem#fill(CoolBar, int)}. * <p> * This interface is internal to the framework; it should not be implemented * outside the framework. This package provides a concrete cool bar manager * implementation, {@link CoolBarManager}, which * clients may instantiate or subclass. * </p> * * @see ToolBarContributionItem * @since 3.0 */ public interface ICoolBarManager : IContributionManager { /** * Property name of a cool item's size (value <code>"size"</code>). * <p> * The cool bar manager uses this property to tell its cool items to update * their size. * </p> * * @see IContributionItem#update(String) @issue consider declaring this * constant elsewhere */ public static const String SIZE = "size"; //$NON-NLS-1$ /** * A convenience method to add a tool bar as a contribution item to this * cool bar manager. Equivalent to <code>add(new ToolBarContributionManager(toolBarManager))</code>. * * @param toolBarManager * the tool bar manager to be added * @see ToolBarContributionItem */ public void add(IToolBarManager toolBarManager); /** * Returns the context menu manager used by this cool bar manager. This * context menu manager is used by the cool bar manager except for cool * items that provide their own. * * @return the context menu manager, or <code>null</code> if none * @see #setContextMenuManager */ public IMenuManager getContextMenuManager(); /** * Returns whether the layout of the underlying cool bar widget is locked. * * @return <code>true</code> if cool bar layout is locked, <code>false</code> * otherwise */ public bool getLockLayout(); /** * Returns the style of the underlying cool bar widget. * * @return the style of the cool bar */ public int getStyle(); /** * Sets the context menu of this cool bar manager to the given menu * manager. * * @param menuManager * the context menu manager, or <code>null</code> if none * @see #getContextMenuManager */ public void setContextMenuManager(IMenuManager menuManager); /** * Locks or unlocks the layout of the underlying cool bar widget. Once the * cool bar is locked, cool items cannot be repositioned by the user. * <p> * Note that items can be added or removed programmatically even while the * cool bar is locked. * </p> * * @param value * <code>true</code> to lock the cool bar, <code>false</code> * to unlock */ public void setLockLayout(bool value); }