#include <juce_TabbedComponent.h>
Classes | |
| struct | ButtonBar |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1005800 , outlineColourId = 0x1005801 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Protected Member Functions | |
| virtual TabBarButton * | createTabButton (const String &tabName, int tabIndex) |
| Protected Member Functions inherited from juce::Component | |
| virtual ComponentPeer * | createNewPeer (int styleFlags, void *nativeWindowToAttachTo) |
Protected Attributes | |
| std::unique_ptr< TabbedButtonBar > | tabs |
Private Member Functions | |
| std::unique_ptr< AccessibilityHandler > | createAccessibilityHandler () override |
| void | changeCallback (int newCurrentTabIndex, const String &newTabName) |
Private Attributes | |
| Array< WeakReference< Component > > | contentComponents |
| WeakReference< Component > | panelComponent |
| int | tabDepth = 30 |
| int | outlineThickness = 1 |
| int | edgeIndent = 0 |
Additional Inherited Members | |
| Static Public Member Functions inherited from juce::Component | |
| static float JUCE_CALLTYPE | getApproximateScaleFactorForComponent (const Component *targetComponent) |
| static Component *JUCE_CALLTYPE | getCurrentlyFocusedComponent () noexcept |
| static void JUCE_CALLTYPE | unfocusAllComponents () |
| static void JUCE_CALLTYPE | beginDragAutoRepeat (int millisecondsBetweenCallbacks) |
| static bool JUCE_CALLTYPE | isMouseButtonDownAnywhere () noexcept |
| static int JUCE_CALLTYPE | getNumCurrentlyModalComponents () noexcept |
| static Component *JUCE_CALLTYPE | getCurrentlyModalComponent (int index=0) noexcept |
| Static Protected Member Functions inherited from juce::Component | |
| static std::unique_ptr< AccessibilityHandler > | createIgnoredAccessibilityHandler (Component &) |
Detailed Description
A component with a TabbedButtonBar along one of its sides.
This makes it easy to create a set of tabbed pages, just add a bunch of tabs with addTab(), and this will take care of showing the pages for you when the user clicks on a different tab.
- See also
- TabbedButtonBar
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::TabbedComponent::ColourIds |
A set of colour IDs to use to change the colour of various aspects of the component.
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 | The colour to fill the background behind the tabs. |
| outlineColourId | The colour to use to draw an outline around the content. (See setOutline) |
Constructor & Destructor Documentation
◆ TabbedComponent()
|
explicit |
Creates a TabbedComponent, specifying where the tabs should be placed. Once created, add some tabs with the addTab() method.
◆ ~TabbedComponent()
|
override |
Destructor.
Member Function Documentation
◆ addTab()
| void juce::TabbedComponent::addTab | ( | const String & | tabName, |
| Colour | tabBackgroundColour, | ||
| Component * | contentComponent, | ||
| bool | deleteComponentWhenNotNeeded, | ||
| int | insertIndex = -1 ) |
Adds a tab to the tab-bar.
The component passed in will be shown for the tab. If deleteComponentWhenNotNeeded is true, then the TabbedComponent will take ownership of the component and will delete it when the tab is removed or when this object is deleted.
- See also
- TabbedButtonBar::addTab
◆ changeCallback()
|
private |
◆ clearTabs()
| void juce::TabbedComponent::clearTabs | ( | ) |
Removes all the tabs from the bar.
- See also
- TabbedButtonBar::clearTabs
◆ createAccessibilityHandler()
|
overrideprivatevirtual |
Override this method to return a custom AccessibilityHandler for this component.
The default implementation creates and returns a AccessibilityHandler object with an unspecified role, meaning that it will be visible to accessibility clients but without a specific role, action callbacks or interfaces. To control how accessibility clients see and interact with your component subclass AccessibilityHandler, implement the desired behaviours, and return an instance of it from this method in your component subclass.
The accessibility handler you return here is guaranteed to be destroyed before its Component, so it's safe to store and use a reference back to the Component inside the AccessibilityHandler if necessary.
- See also
- getAccessibilityHandler
Reimplemented from juce::Component.
◆ createTabButton()
|
protectedvirtual |
This creates one of the tab buttons.
If you need to use custom tab components, you can override this method and return your own class instead of the default.
◆ currentTabChanged()
|
virtual |
Callback method to indicate the selected tab has been changed.
- See also
- setCurrentTabIndex
Reimplemented in juce::MultiDocumentPanel::TabbedComponentInternal.
◆ getCurrentContentComponent()
|
inlinenoexcept |
Returns the current component that's filling the panel. This will return nullptr if there isn't one.
◆ getCurrentTabIndex()
| int juce::TabbedComponent::getCurrentTabIndex | ( | ) | const |
Returns the index of the currently selected tab.
- See also
- addTab, TabbedButtonBar::getCurrentTabIndex()
◆ getCurrentTabName()
| String juce::TabbedComponent::getCurrentTabName | ( | ) | const |
Returns the name of the currently selected tab.
- See also
- addTab, TabbedButtonBar::getCurrentTabName()
◆ getNumTabs()
| int juce::TabbedComponent::getNumTabs | ( | ) | const |
Returns the number of tabs in the bar.
◆ getOrientation()
|
noexcept |
Returns the current tab placement.
- See also
- setOrientation, TabbedButtonBar::getOrientation
◆ getTabBackgroundColour()
Returns the colour of one of the tabs.
◆ getTabBarDepth()
|
inlinenoexcept |
Returns the current thickness of the tab bar.
- See also
- setTabBarDepth
◆ getTabbedButtonBar()
|
inlinenoexcept |
Returns the tab button bar component that is being used.
◆ getTabContentComponent()
Returns the content component that was added for the given index. Be careful not to reposition or delete the components that are returned, as this will interfere with the TabbedComponent's behaviour.
◆ getTabNames()
| StringArray juce::TabbedComponent::getTabNames | ( | ) | const |
Returns a list of all the tab names in the bar.
◆ lookAndFeelChanged()
|
overridevirtual |
Called to let the component react to a change in the look-and-feel setting.
When the look-and-feel is changed for a component, this will be called in all its child components, recursively.
It can also be triggered manually by the sendLookAndFeelChange() method, in case an application uses a LookAndFeel class that might have changed internally.
- See also
- sendLookAndFeelChange, getLookAndFeel
Reimplemented from juce::Component.
◆ moveTab()
Moves a tab to a new index in the list. Pass -1 as the index to move it to the end of the list.
◆ paint()
Components can override this method to draw their content.
The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.
Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.
If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.
You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
◆ popupMenuClickOnTab()
Callback method to indicate that the user has right-clicked on a tab.
◆ removeTab()
◆ resized()
|
overridevirtual |
Called when this component's size has been changed.
A component can implement this method to do things such as laying out its child components when its width or height changes.
The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).
If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.
- See also
- moved, setSize
Reimplemented from juce::Component.
◆ setCurrentTabIndex()
Changes the currently-selected tab. To deselect all the tabs, pass -1 as the index.
- See also
- TabbedButtonBar::setCurrentTabIndex
◆ setIndent()
Specifies a gap to leave around the edge of the content component. Each edge of the content component will be indented by the given number of pixels.
◆ setOrientation()
| void juce::TabbedComponent::setOrientation | ( | TabbedButtonBar::Orientation | orientation | ) |
Changes the placement of the tabs.
This will rearrange the layout to place the tabs along the appropriate side of this component, and will shift the content component accordingly.
- See also
- TabbedButtonBar::setOrientation
◆ setOutline()
Specifies the thickness of an outline that should be drawn around the content component.
If this thickness is > 0, a line will be drawn around the three sides of the content component which don't touch the tab-bar, and the content component will be inset by this amount.
To set the colour of the line, use setColour (outlineColourId, ...).
◆ setTabBackgroundColour()
Changes the background colour of one of the tabs.
◆ setTabBarDepth()
Specifies how many pixels wide or high the tab-bar should be.
If the tabs are placed along the top or bottom, this specified the height of the bar; if they're along the left or right edges, it'll be the width of the bar.
◆ setTabName()
Changes the name of one of the tabs.
Member Data Documentation
◆ contentComponents
|
private |
◆ edgeIndent
|
private |
◆ outlineThickness
|
private |
◆ panelComponent
|
private |
◆ tabDepth
|
private |
◆ tabs
|
protected |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/layout/juce_TabbedComponent.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/layout/juce_TabbedComponent.cpp
Generated on for LMMS by
1.16.1