JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Toolbar Class Reference

A toolbar component. More...

Inherits Component, DragAndDropContainer, DragAndDropTarget, and ButtonListener.

Classes

struct  LookAndFeelMethods
 This abstract base class is implemented by LookAndFeel classes. More...
 

Public Types

enum  ToolbarItemStyle { iconsOnly, iconsWithText, textOnly }
 Options for the way items should be displayed. More...
 
enum  CustomisationFlags {
  allowIconsOnlyChoice = 1, allowIconsWithTextChoice = 2, allowTextOnlyChoice = 4, showResetToDefaultsButton = 8,
  allCustomisationOptionsEnabled = (allowIconsOnlyChoice | allowIconsWithTextChoice | allowTextOnlyChoice | showResetToDefaultsButton)
}
 Flags used by the showCustomisationDialog() method. More...
 
enum  ColourIds {
  backgroundColourId = 0x1003200, separatorColourId = 0x1003210, buttonMouseOverBackgroundColourId = 0x1003220, buttonMouseDownBackgroundColourId = 0x1003230,
  labelTextColourId = 0x1003240, editingModeOutlineColourId = 0x1003250
}
 A set of colour IDs to use to change the colour of various aspects of the toolbar. More...
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 Enumeration used by the focusChanged() and focusLost() methods. More...
 

Public Member Functions

 Toolbar ()
 Creates an empty toolbar component.
 
 ~Toolbar ()
 Destructor.
 
void setVertical (bool shouldBeVertical)
 Changes the bar's orientation.
 
bool isVertical () const noexcept
 Returns true if the bar is set to be vertical, or false if it's horizontal.
 
int getThickness () const noexcept
 Returns the depth of the bar.
 
int getLength () const noexcept
 Returns the length of the bar.
 
void clear ()
 Deletes all items from the bar.
 
void addItem (ToolbarItemFactory &factory, int itemId, int insertIndex=-1)
 Adds an item to the toolbar.
 
void removeToolbarItem (int itemIndex)
 Deletes one of the items from the bar.
 
ToolbarItemComponentremoveAndReturnItem (int itemIndex)
 Removes an item from the bar and returns it.
 
int getNumItems () const noexcept
 Returns the number of items currently on the toolbar.
 
int getItemId (int itemIndex) const noexcept
 Returns the ID of the item with the given index.
 
ToolbarItemComponentgetItemComponent (int itemIndex) const noexcept
 Returns the component being used for the item with the given index.
 
void addDefaultItems (ToolbarItemFactory &factoryToUse)
 Clears this toolbar and adds to it the default set of items that the specified factory creates.
 
ToolbarItemStyle getStyle () const noexcept
 Returns the toolbar's current style.
 
void setStyle (const ToolbarItemStyle &newStyle)
 Changes the toolbar's current style.
 
void showCustomisationDialog (ToolbarItemFactory &factory, int optionFlags=allCustomisationOptionsEnabled)
 Pops up a modal dialog box that allows this toolbar to be customised by the user.
 
void setEditingActive (bool editingEnabled)
 Turns on or off the toolbar's editing mode, in which its items can be rearranged by the user.
 
String toString () const
 Returns a string that represents the toolbar's current set of items.
 
bool restoreFromString (ToolbarItemFactory &factoryToUse, const String &savedVersion)
 Restores a set of items that was previously stored in a string by the toString() method.
 
void paint (Graphics &) override
 
void resized () override
 
void mouseDown (const MouseEvent &) override
 
bool isInterestedInDragSource (const SourceDetails &) override
 
void itemDragMove (const SourceDetails &) override
 
void itemDragExit (const SourceDetails &) override
 
void itemDropped (const SourceDetails &) override
 
void updateAllItemPositions (bool animate)
 
- Public Member Functions inherited from Component
 Component ()
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName)
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
const StringgetComponentID () const noexcept
 Returns the ID string that was set by setComponentID().
 
void setComponentID (const String &newID)
 Sets the component's ID string.
 
virtual void setVisible (bool shouldBeVisible)
 Makes the component visible or invisible.
 
bool isVisible () const noexcept
 Tests whether the component is visible or not.
 
virtual void visibilityChanged ()
 Called when this component's visibility changes.
 
bool isShowing () const
 Tests whether this component and all its parents are visible.
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 Makes this component appear as a window on the desktop.
 
void removeFromDesktop ()
 If the component is currently showing on the desktop, this will hide it.
 
bool isOnDesktop () const noexcept
 Returns true if this component is currently showing on the desktop.
 
ComponentPeergetPeer () const
 Returns the heavyweight window that contains this component.
 
virtual void userTriedToCloseWindow ()
 For components on the desktop, this is called if the system wants to close the window.
 
virtual void minimisationStateChanged (bool isNowMinimised)
 Called for a desktop component which has just been minimised or un-minimised.
 
virtual float getDesktopScaleFactor () const
 Returns the default scale factor to use for this component when it is placed on the desktop.
 
void toFront (bool shouldAlsoGainFocus)
 Brings the component to the front of its siblings.
 
void toBack ()
 Changes this component's z-order to be at the back of all its siblings.
 
void toBehind (Component *other)
 Changes this component's z-order so that it's just behind another component.
 
void setAlwaysOnTop (bool shouldStayOnTop)
 Sets whether the component should always be kept at the front of its siblings.
 
bool isAlwaysOnTop () const noexcept
 Returns true if this component is set to always stay in front of its siblings.
 
int getX () const noexcept
 Returns the x coordinate of the component's left edge.
 
int getY () const noexcept
 Returns the y coordinate of the top of this component.
 
int getWidth () const noexcept
 Returns the component's width in pixels.
 
int getHeight () const noexcept
 Returns the component's height in pixels.
 
int getRight () const noexcept
 Returns the x coordinate of the component's right-hand edge.
 
Point< int > getPosition () const noexcept
 Returns the component's top-left position as a Point.
 
int getBottom () const noexcept
 Returns the y coordinate of the bottom edge of this component.
 
const Rectangle< int > & getBounds () const noexcept
 Returns this component's bounding box.
 
Rectangle< int > getLocalBounds () const noexcept
 Returns the component's bounds, relative to its own origin.
 
Rectangle< int > getBoundsInParent () const noexcept
 Returns the area of this component's parent which this component covers.
 
void getVisibleArea (RectangleList< int > &result, bool includeSiblings) const
 Returns the region of this component that's not obscured by other, opaque components.
 
int getScreenX () const
 Returns this component's x coordinate relative the screen's top-left origin.
 
int getScreenY () const
 Returns this component's y coordinate relative the screen's top-left origin.
 
Point< int > getScreenPosition () const
 Returns the position of this component's top-left corner relative to the screen's top-left.
 
Rectangle< int > getScreenBounds () const
 Returns the bounds of this component, relative to the screen's top-left.
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 Converts a point to be relative to this component's coordinate space.
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 Converts a point relative to this component's top-left into a screen coordinate.
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
void setTopLeftPosition (int x, int y)
 Moves the component to a new position.
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 Moves the component to a new position.
 
void setTopRightPosition (int x, int y)
 Moves the component to a new position.
 
void setSize (int newWidth, int newHeight)
 Changes the size of the component.
 
void setBounds (int x, int y, int width, int height)
 Changes the component's position and size.
 
void setBounds (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 Positions the component within a given rectangle, keeping its proportions unchanged.
 
void setCentrePosition (int x, int y)
 Changes the position of the component's centre.
 
void setCentreRelative (float x, float y)
 Changes the position of the component's centre.
 
void centreWithSize (int width, int height)
 Changes the component's size and centres it within its parent.
 
void setTransform (const AffineTransform &transform)
 Sets a transform matrix to be applied to this component.
 
AffineTransform getTransform () const
 Returns the transform that is currently being applied to this component.
 
bool isTransformed () const noexcept
 Returns true if a non-identity transform is being applied to this component.
 
int proportionOfWidth (float proportion) const noexcept
 Returns a proportion of the component's width.
 
int proportionOfHeight (float proportion) const noexcept
 Returns a proportion of the component's height.
 
int getParentWidth () const noexcept
 Returns the width of the component's parent.
 
int getParentHeight () const noexcept
 Returns the height of the component's parent.
 
Rectangle< int > getParentMonitorArea () const
 Returns the screen coordinates of the monitor that contains this component.
 
int getNumChildComponents () const noexcept
 Returns the number of child components that this component contains.
 
ComponentgetChildComponent (int index) const noexcept
 Returns one of this component's child components, by it index.
 
int getIndexOfChildComponent (const Component *child) const noexcept
 Returns the index of this component in the list of child components.
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 Looks for a child component with the specified ID.
 
void addChildComponent (Component *child, int zOrder=-1)
 Adds a child component to this one.
 
void addChildComponent (Component &child, int zOrder=-1)
 Adds a child component to this one.
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 Adds a child component to this one, and also makes the child visible if it isn't already.
 
void addChildAndSetID (Component *child, const String &componentID)
 Adds a child component to this one, makes it visible, and sets its component ID.
 
void removeChildComponent (Component *childToRemove)
 Removes one of this component's child-components.
 
ComponentremoveChildComponent (int childIndexToRemove)
 Removes one of this component's child-components by index.
 
void removeAllChildren ()
 Removes all this component's children.
 
void deleteAllChildren ()
 Removes all this component's children, and deletes them.
 
ComponentgetParentComponent () const noexcept
 Returns the component which this component is inside.
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 Searches the parent components for a component of a specified class.
 
ComponentgetTopLevelComponent () const noexcept
 Returns the highest-level component which contains this one or its parents.
 
bool isParentOf (const Component *possibleChild) const noexcept
 Checks whether a component is anywhere inside this component or its children.
 
virtual void parentHierarchyChanged ()
 Called to indicate that the component's parents have changed.
 
virtual void childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 Changes the default return value for the hitTest() method.
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 Retrieves the current state of the mouse-click interception flags.
 
bool contains (Point< int > localPoint)
 Returns true if a given point lies within this component or one of its children.
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 Returns true if a given point lies in this component, taking any overlapping siblings into account.
 
ComponentgetComponentAt (int x, int y)
 Returns the component at a certain point within this one.
 
ComponentgetComponentAt (Point< int > position)
 Returns the component at a certain point within this one.
 
void repaint ()
 Marks the whole component as needing to be redrawn.
 
void repaint (int x, int y, int width, int height)
 Marks a subsection of this component as needing to be redrawn.
 
void repaint (const Rectangle< int > &area)
 Marks a subsection of this component as needing to be redrawn.
 
void setBufferedToImage (bool shouldBeBuffered)
 Makes the component use an internal buffer to optimise its redrawing.
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 Generates a snapshot of part of this component.
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 Draws this component and all its subcomponents onto the specified graphics context.
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
 
void setComponentEffect (ImageEffectFilter *newEffect)
 Adds an effect filter to alter the component's appearance.
 
ImageEffectFiltergetComponentEffect () const noexcept
 Returns the current component effect.
 
LookAndFeelgetLookAndFeel () const noexcept
 Finds the appropriate look-and-feel to use for this component.
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 Sets the look and feel to use for this component.
 
virtual void lookAndFeelChanged ()
 Called to let the component react to a change in the look-and-feel setting.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
void setOpaque (bool shouldBeOpaque)
 Indicates whether any parts of the component might be transparent.
 
bool isOpaque () const noexcept
 Returns true if no parts of this component are transparent.
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 Indicates whether the component should be brought to the front when clicked.
 
bool isBroughtToFrontOnMouseClick () const noexcept
 Indicates whether the component should be brought to the front when clicked-on.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs keyboard focus or not.
 
bool getWantsKeyboardFocus () const noexcept
 Returns true if the component is interested in getting keyboard focus.
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 Chooses whether a click on this component automatically grabs the focus.
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 Returns the last value set with setMouseClickGrabsKeyboardFocus().
 
void grabKeyboardFocus ()
 Tries to give keyboard focus to this component.
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 Returns true if this component currently has the keyboard focus.
 
void moveKeyboardFocusToSibling (bool moveToNext)
 Tries to move the keyboard focus to one of this component's siblings.
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
void setMouseCursor (const MouseCursor &cursorType)
 Changes the mouse cursor shape to use when the mouse is over this component.
 
virtual MouseCursor getMouseCursor ()
 Returns the mouse cursor shape to use when the mouse is over this component.
 
void updateMouseCursor () const
 Forces the current mouse cursor to be updated.
 
virtual void paintOverChildren (Graphics &g)
 Components can override this method to draw over the top of their children.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
virtual void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down.
 
virtual void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released.
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 Called when a pinch-to-zoom mouse-gesture is used.
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 Causes automatic repaints when the mouse enters or exits this component.
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 Registers a listener to be told when mouse events occur in this component.
 
void removeMouseListener (MouseListener *listenerToRemove)
 Deregisters a mouse listener.
 
void addKeyListener (KeyListener *newListener)
 Adds a listener that wants to hear about keypresses that this component receives.
 
void removeKeyListener (KeyListener *listenerToRemove)
 Removes a previously-registered key listener.
 
virtual bool keyPressed (const KeyPress &key)
 Called when a key is pressed.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate that one of this component's children has been focused or unfocused.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () const
 True if the mouse is over this component, or if it's being dragged in this component.
 
Point< int > getMouseXYRelative () const
 Returns the mouse's current position, relative to this component.
 
virtual void moved ()
 Called when this component's position has been changed.
 
virtual void childBoundsChanged (Component *child)
 Called when one of this component's children is moved or resized.
 
virtual void parentSizeChanged ()
 Called when this component's immediate parent has been resized.
 
virtual void broughtToFront ()
 Called when this component has been moved to the front of its siblings.
 
void addComponentListener (ComponentListener *newListener)
 Adds a listener to be told about changes to the component hierarchy or position.
 
void removeComponentListener (ComponentListener *listenerToRemove)
 Removes a component listener.
 
void postCommandMessage (int commandId)
 Dispatches a numbered message to this component.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () const noexcept
 Returns true if this component is the modal one.
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 When a component is modal, this callback allows it to choose which other components can still receive events.
 
virtual void inputAttemptWhenModal ()
 Called when the user tries to click on a component that is blocked by another modal component.
 
NamedValueSetgetProperties () noexcept
 Returns the set of properties that belong to this component.
 
const NamedValueSetgetProperties () const noexcept
 Returns the set of properties that belong to this component.
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 Looks for a colour that has been registered with the given colour ID number.
 
void setColour (int colourId, Colour newColour)
 Registers a colour to be used for a particular purpose.
 
void removeColour (int colourId)
 If a colour has been set with setColour(), this will remove it.
 
bool isColourSpecified (int colourId) const
 Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
 
void copyAllExplicitColoursTo (Component &target) const
 This looks for any colours that have been specified for this component, and copies them to the specified target component.
 
virtual void colourChanged ()
 This method is called when a colour is changed by the setColour() method.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
void * getWindowHandle () const
 Returns the underlying native window handle for this component.
 
PositionergetPositioner () const noexcept
 Returns the Positioner object that has been set for this component.
 
void setPositioner (Positioner *newPositioner)
 Sets a new Positioner object for this component.
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 Gives the component a CachedComponentImage that should be used to buffer its painting.
 
CachedComponentImagegetCachedComponentImage () const noexcept
 Returns the object that was set by setCachedComponentImage().
 
 JUCE_DEPRECATED (Point< int > relativePositionToGlobal(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > globalPositionToRelative(Point< int >) const)
 
 JUCE_DEPRECATED (Point< int > relativePositionToOtherComponent(const Component *, Point< int >) const)
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()
 Destructor.
 
- Public Member Functions inherited from DragAndDropContainer
 DragAndDropContainer ()
 Creates a DragAndDropContainer.
 
virtual ~DragAndDropContainer ()
 Destructor.
 
void startDragging (const var &sourceDescription, Component *sourceComponent, Image dragImage=Image::null, bool allowDraggingToOtherJuceWindows=false, const Point< int > *imageOffsetFromMouse=nullptr)
 Begins a drag-and-drop operation.
 
bool isDragAndDropActive () const
 Returns true if something is currently being dragged.
 
var getCurrentDragDescription () const
 Returns the description of the thing that's currently being dragged.
 
- Public Member Functions inherited from DragAndDropTarget
virtual ~DragAndDropTarget ()
 Destructor.
 
virtual void itemDragEnter (const SourceDetails &dragSourceDetails)
 Callback to indicate that something is being dragged over this component.
 
virtual bool shouldDrawDragImageWhenOver ()
 Overriding this allows the target to tell the drag container whether to draw the drag image while the cursor is over it.
 

Static Public Member Functions

static ToolbarItemComponentcreateItem (ToolbarItemFactory &, int itemId)
 
- Static Public Member Functions inherited from Component
static Component *JUCE_CALLTYPE getCurrentlyFocusedComponent () noexcept
 Returns the component that currently has the keyboard focus.
 
static void JUCE_CALLTYPE unfocusAllComponents ()
 If any component has keyboard focus, this will defocus it.
 
static void JUCE_CALLTYPE beginDragAutoRepeat (int millisecondsBetweenCallbacks)
 Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
 
static bool JUCE_CALLTYPE isMouseButtonDownAnywhere () noexcept
 Returns true if a mouse button is currently down.
 
static int JUCE_CALLTYPE getNumCurrentlyModalComponents () noexcept
 Returns the number of components that are currently in a modal state.
 
static Component *JUCE_CALLTYPE getCurrentlyModalComponent (int index=0) noexcept
 Returns one of the components that are currently modal.
 
- Static Public Member Functions inherited from DragAndDropContainer
static DragAndDropContainerfindParentDragContainerFor (Component *childComponent)
 Utility to find the DragAndDropContainer for a given Component.
 
static bool performExternalDragDropOfFiles (const StringArray &files, bool canMoveFiles)
 This performs a synchronous drag-and-drop of a set of files to some external application.
 
static bool performExternalDragDropOfText (const String &text)
 This performs a synchronous drag-and-drop of a block of text to some external application.
 

Static Public Attributes

static const char *const toolbarDragDescriptor
 

Additional Inherited Members

- Protected Member Functions inherited from DragAndDropContainer
virtual bool shouldDropFilesWhenDraggedExternally (const DragAndDropTarget::SourceDetails &sourceDetails, StringArray &files, bool &canMoveFiles)
 Override this if you want to be able to perform an external drag a set of files when the user drags outside of this container component.
 

Detailed Description

A toolbar component.

A toolbar contains a horizontal or vertical strip of ToolbarItemComponents, and looks after their order and layout.

Items (icon buttons or other custom components) are added to a toolbar using a ToolbarItemFactory - each type of item is given a unique ID number, and a toolbar might contain more than one instance of a particular item type.

Toolbars can be interactively customised, allowing the user to drag the items around, and to drag items onto or off the toolbar, using the ToolbarItemPalette component as a source of new items.

See Also
ToolbarItemFactory, ToolbarItemComponent, ToolbarItemPalette

Member Enumeration Documentation

Options for the way items should be displayed.

See Also
setStyle, getStyle
Enumerator:
iconsOnly 

Means that the toolbar should just contain icons.

iconsWithText 

Means that the toolbar should have text labels under each icon.

textOnly 

Means that the toolbar only display text labels for each item.

Flags used by the showCustomisationDialog() method.

Enumerator:
allowIconsOnlyChoice 

If this flag is specified, the customisation dialog can show the "icons only" option on its choice of toolbar styles.

allowIconsWithTextChoice 

If this flag is specified, the customisation dialog can show the "icons with text" option on its choice of toolbar styles.

allowTextOnlyChoice 

If this flag is specified, the customisation dialog can show the "text only" option on its choice of toolbar styles.

showResetToDefaultsButton 

If this flag is specified, the customisation dialog can show a button to reset the toolbar to its default set of items.

allCustomisationOptionsEnabled 

A set of colour IDs to use to change the colour of various aspects of the toolbar.

These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.

See Also
Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
Enumerator:
backgroundColourId 

A colour to use to fill the toolbar's background.

For more control over this, override LookAndFeel::paintToolbarBackground().

separatorColourId 

A colour to use to draw the separator lines.

buttonMouseOverBackgroundColourId 

A colour used to paint the background of buttons when the mouse is over them.

buttonMouseDownBackgroundColourId 

A colour used to paint the background of buttons when the mouse is held down on them.

labelTextColourId 

A colour to use for drawing the text under buttons when the style is set to iconsWithText or textOnly.

editingModeOutlineColourId 

A colour to use for an outline around buttons when the customisation dialog is active and the mouse moves over them.

Constructor & Destructor Documentation

Toolbar::Toolbar ( )

Creates an empty toolbar component.

To add some icons or other components to your toolbar, you'll need to create a ToolbarItemFactory class that can create a suitable set of ToolbarItemComponents.

See Also
ToolbarItemFactory, ToolbarItemComponents
Toolbar::~Toolbar ( )

Destructor.

Any items on the bar will be deleted when the toolbar is deleted.

Member Function Documentation

void Toolbar::setVertical ( bool  shouldBeVertical)

Changes the bar's orientation.

See Also
isVertical
bool Toolbar::isVertical ( ) const
noexcept

Returns true if the bar is set to be vertical, or false if it's horizontal.

You can change the bar's orientation with setVertical().

int Toolbar::getThickness ( ) const
noexcept

Returns the depth of the bar.

If the bar is horizontal, this will return its height; if it's vertical, it will return its width.

See Also
getLength
int Toolbar::getLength ( ) const
noexcept

Returns the length of the bar.

If the bar is horizontal, this will return its width; if it's vertical, it will return its height.

See Also
getThickness
void Toolbar::clear ( )

Deletes all items from the bar.

void Toolbar::addItem ( ToolbarItemFactory factory,
int  itemId,
int  insertIndex = -1 
)

Adds an item to the toolbar.

The factory's ToolbarItemFactory::createItem() will be called by this method to create the component that will actually be added to the bar.

The new item will be inserted at the specified index (if the index is -1, it will be added to the right-hand or bottom end of the bar).

Once added, the component will be automatically deleted by this object when it is no longer needed.

See Also
ToolbarItemFactory
void Toolbar::removeToolbarItem ( int  itemIndex)

Deletes one of the items from the bar.

ToolbarItemComponent* Toolbar::removeAndReturnItem ( int  itemIndex)

Removes an item from the bar and returns it.

int Toolbar::getNumItems ( ) const
noexcept

Returns the number of items currently on the toolbar.

See Also
getItemId, getItemComponent
int Toolbar::getItemId ( int  itemIndex) const
noexcept

Returns the ID of the item with the given index.

If the index is less than zero or greater than the number of items, this will return 0.

See Also
getNumItems
ToolbarItemComponent* Toolbar::getItemComponent ( int  itemIndex) const
noexcept

Returns the component being used for the item with the given index.

If the index is less than zero or greater than the number of items, this will return 0.

See Also
getNumItems
void Toolbar::addDefaultItems ( ToolbarItemFactory factoryToUse)

Clears this toolbar and adds to it the default set of items that the specified factory creates.

See Also
ToolbarItemFactory::getDefaultItemSet
ToolbarItemStyle Toolbar::getStyle ( ) const
noexcept

Returns the toolbar's current style.

See Also
ToolbarItemStyle, setStyle
void Toolbar::setStyle ( const ToolbarItemStyle newStyle)

Changes the toolbar's current style.

See Also
ToolbarItemStyle, getStyle, ToolbarItemComponent::setStyle
void Toolbar::showCustomisationDialog ( ToolbarItemFactory factory,
int  optionFlags = allCustomisationOptionsEnabled 
)

Pops up a modal dialog box that allows this toolbar to be customised by the user.

The dialog contains a ToolbarItemPalette and various controls for editing other aspects of the toolbar. The dialog box will be opened modally, but the method will return immediately.

The factory is used to determine the set of items that will be shown on the palette.

The optionFlags parameter is a bitwise-or of values from the CustomisationFlags enum.

See Also
ToolbarItemPalette
void Toolbar::setEditingActive ( bool  editingEnabled)

Turns on or off the toolbar's editing mode, in which its items can be rearranged by the user.

(In most cases it's easier just to use showCustomisationDialog() instead of trying to enable editing directly).

See Also
ToolbarItemPalette
String Toolbar::toString ( ) const

Returns a string that represents the toolbar's current set of items.

This lets you later restore the same item layout using restoreFromString().

See Also
restoreFromString
bool Toolbar::restoreFromString ( ToolbarItemFactory factoryToUse,
const String savedVersion 
)

Restores a set of items that was previously stored in a string by the toString() method.

The factory object is used to create any item components that are needed.

See Also
toString
void Toolbar::paint ( Graphics )
overridevirtual

Reimplemented from Component.

void Toolbar::resized ( )
overridevirtual

Reimplemented from Component.

void Toolbar::mouseDown ( const MouseEvent )
overridevirtual

Reimplemented from Component.

bool Toolbar::isInterestedInDragSource ( const SourceDetails )
overridevirtual

Implements DragAndDropTarget.

void Toolbar::itemDragMove ( const SourceDetails )
overridevirtual

Reimplemented from DragAndDropTarget.

void Toolbar::itemDragExit ( const SourceDetails )
overridevirtual

Reimplemented from DragAndDropTarget.

void Toolbar::itemDropped ( const SourceDetails )
overridevirtual

Implements DragAndDropTarget.

void Toolbar::updateAllItemPositions ( bool  animate)
static ToolbarItemComponent* Toolbar::createItem ( ToolbarItemFactory ,
int  itemId 
)
static

Member Data Documentation

const char* const Toolbar::toolbarDragDescriptor
static

The documentation for this class was generated from the following file: