JUCE: ToolbarItemFactory Class Reference

JUCE

Public Types | Public Member Functions | List of all members
ToolbarItemFactory Class Referenceabstract
juce_gui_basics » widgets

A factory object which can create ToolbarItemComponent objects. More...

`#include <juce_ToolbarItemFactory.h>`

## Public Types
enum | SpecialItemIds { separatorBarId = -1 , spacerId = -2 , flexibleSpacerId = -3 }
| A set of reserved item ID values, used for the built-in item types. More...

## Public Member Functions
| ToolbarItemFactory ()
virtual | ~ToolbarItemFactory ()
| Destructor. More...
virtual void | getAllToolbarItemIds (Array< int > &ids)=0
| Must return a list of the IDs for all the item types that this factory can create. More...
virtual void | getDefaultItemSet (Array< int > &ids)=0
| Must return the set of items that should be added to a toolbar as its default set. More...
virtual ToolbarItemComponent * | createItem (int itemId)=0
| Must create an instance of one of the items that the factory lists in its getAllToolbarItemIds() method. More...

## Detailed Description

A factory object which can create ToolbarItemComponent objects.

A subclass of ToolbarItemFactory publishes a set of types of toolbar item that it can create.

Each type of item is identified by a unique ID, and multiple instances of an item type can exist at once (even on the same toolbar, e.g. spacers or separator bars).

See also
  Toolbar, ToolbarItemComponent, ToolbarButton

## Member Enumeration Documentation

## ◆ SpecialItemIds

enum ToolbarItemFactory::SpecialItemIds

A set of reserved item ID values, used for the built-in item types.

Enumerator
separatorBarId | The item ID for a vertical (or horizontal) separator bar that can be placed between sets of items to break them into groups.
spacerId | The item ID for a fixed-width space that can be placed between items.
flexibleSpacerId | The item ID for a gap that pushes outwards against the things on either side of it, filling any available space.

## Constructor & Destructor Documentation

## ◆ ToolbarItemFactory()

ToolbarItemFactory::ToolbarItemFactory | ( |  | ) |

## ◆ ~ToolbarItemFactory()

virtual ToolbarItemFactory::~ToolbarItemFactory | ( |  | ) |
| virtual

Destructor.

## Member Function Documentation

## ◆ getAllToolbarItemIds()

virtual void ToolbarItemFactory::getAllToolbarItemIds | ( | Array< int > & | ids | ) |
| pure virtual

Must return a list of the IDs for all the item types that this factory can create.

The ids should be added to the array that is passed-in.

An item ID can be any integer you choose, except for 0, which is considered a null ID, and the predefined IDs in the SpecialItemIds enum.

You should also add the built-in types (separatorBarId, spacerId and flexibleSpacerId) to this list if you want your toolbar to be able to contain those items.

The list returned here is used by the ToolbarItemPalette class to obtain its list of available items, and their order on the palette will reflect the order in which they appear on this list.

See also
  ToolbarItemPalette

## ◆ getDefaultItemSet()

virtual void ToolbarItemFactory::getDefaultItemSet | ( | Array< int > & | ids | ) |
| pure virtual

Must return the set of items that should be added to a toolbar as its default set.

This method is used by Toolbar::addDefaultItems() to determine which items to create.

The items that your method adds to the array that is passed-in will be added to the toolbar in the same order. Items can appear in the list more than once.

## ◆ createItem()

virtual ToolbarItemComponent * ToolbarItemFactory::createItem | ( | int | itemId | ) |
| pure virtual

Must create an instance of one of the items that the factory lists in its getAllToolbarItemIds() method.

The itemId parameter can be any of the values listed by your getAllToolbarItemIds() method, except for the built-in item types from the SpecialItemIds enum, which are created internally by the toolbar code.

Try not to keep a pointer to the object that is returned, as it will be deleted automatically by the toolbar, and remember that multiple instances of the same item type are likely to exist at the same time.

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

- juce_ToolbarItemFactory.h