Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | List of all members
TabBarButton Class Reference

In a TabbedButtonBar, this component is used for each of the buttons. More...

#include <juce_TabbedButtonBar.h>

Inheritance diagram for TabBarButton:

Public Types

enum  ExtraComponentPlacement { beforeText , afterText }
 When adding an extra component to the tab, this indicates which side of the text it should be placed on. More...
 
- Public Types inherited from Button
enum  ConnectedEdgeFlags { ConnectedOnLeft = 1 , ConnectedOnRight = 2 , ConnectedOnTop = 4 , ConnectedOnBottom = 8 }
 A combination of these flags are used by setConnectedEdges(). More...
 
enum  ButtonState { buttonNormal , buttonOver , buttonDown }
 Used by setState(). More...
 
- Public Types inherited from Component
enum class  FocusContainerType { none , focusContainer , keyboardFocusContainer }
 A focus container type that can be passed to setFocusContainerType(). More...
 
enum  FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly }
 Enumeration used by the focusGained() and focusLost() methods. More...
 
enum class  FocusChangeDirection { unknown , forward , backward }
 Enumeration used by the focusGainedWithDirection() method. More...
 

Public Member Functions

 TabBarButton (const String &name, TabbedButtonBar &ownerBar)
 Creates the tab button.
 
 ~TabBarButton () override
 Destructor.
 
TabbedButtonBargetTabbedButtonBar () const
 Returns the bar that contains this button.
 
void setExtraComponent (Component *extraTabComponent, ExtraComponentPlacement extraComponentPlacement)
 Sets an extra component that will be shown in the tab.
 
ComponentgetExtraComponent () const noexcept
 Returns the custom component, if there is one.
 
ExtraComponentPlacement getExtraComponentPlacement () const noexcept
 Returns the placement of the custom component, if there is one.
 
Rectangle< intgetActiveArea () const
 Returns an area of the component that's safe to draw in.
 
Rectangle< intgetTextArea () const
 Returns the area of the component that should contain its text.
 
int getIndex () const
 Returns this tab's index in its tab bar.
 
Colour getTabBackgroundColour () const
 Returns the colour of the tab.
 
bool isFrontTab () const
 Returns true if this is the frontmost (selected) tab.
 
virtual int getBestTabLength (int depth)
 Chooses the best length for the tab, given the specified depth.
 
void paintButton (Graphics &, bool, bool) override
 Subclasses should override this to actually paint the button's contents.
 
void clicked (const ModifierKeys &) override
 This method is called when the button has been clicked.
 
bool hitTest (int x, int y) override
 Tests whether a given point is inside the component.
 
void resized () override
 Called when this component's size has been changed.
 
void childBoundsChanged (Component *) override
 Called when one of this component's children is moved or resized.
 
- Public Member Functions inherited from Button
 ~Button () override
 Destructor.
 
void setButtonText (const String &newText)
 Changes the button's text.
 
const StringgetButtonText () const
 Returns the text displayed in the button.
 
bool isDown () const noexcept
 Returns true if the button is currently being held down.
 
bool isOver () const noexcept
 Returns true if the mouse is currently over the button.
 
void setToggleable (bool shouldBeToggleable)
 Indicates that the button's on/off state is toggleable.
 
bool isToggleable () const noexcept
 Returns true if the button's on/off state is toggleable.
 
void setToggleState (bool shouldBeOn, NotificationType notification)
 A button has an on/off state associated with it, and this changes that.
 
bool getToggleState () const noexcept
 Returns true if the button is 'on'.
 
ValuegetToggleStateValue () noexcept
 Returns the Value object that represents the button's toggle state.
 
void setClickingTogglesState (bool shouldAutoToggleOnClick) noexcept
 This tells the button to automatically flip the toggle state when the button is clicked.
 
bool getClickingTogglesState () const noexcept
 Returns true if this button is set to be an automatic toggle-button.
 
void setRadioGroupId (int newGroupId, NotificationType notification=sendNotification)
 Enables the button to act as a member of a mutually-exclusive group of 'radio buttons'.
 
int getRadioGroupId () const noexcept
 Returns the ID of the group to which this button belongs.
 
void addListener (Listener *newListener)
 Registers a listener to receive events when this button's state changes.
 
void removeListener (Listener *listener)
 Removes a previously-registered button listener.
 
virtual void triggerClick ()
 Causes the button to act as if it's been clicked.
 
void setCommandToTrigger (ApplicationCommandManager *commandManagerToUse, CommandID commandID, bool generateTooltip)
 Sets a command ID for this button to automatically invoke when it's clicked.
 
CommandID getCommandID () const noexcept
 Returns the command ID that was set by setCommandToTrigger().
 
void addShortcut (const KeyPress &)
 Assigns a shortcut key to trigger the button.
 
void clearShortcuts ()
 Removes all key shortcuts that had been set for this button.
 
bool isRegisteredForShortcut (const KeyPress &) const
 Returns true if the given keypress is a shortcut for this button.
 
void setRepeatSpeed (int initialDelayInMillisecs, int repeatDelayInMillisecs, int minimumDelayInMillisecs=-1) noexcept
 Sets an auto-repeat speed for the button when it is held down.
 
void setTriggeredOnMouseDown (bool isTriggeredOnMouseDown) noexcept
 Sets whether the button click should happen when the mouse is pressed or released.
 
bool getTriggeredOnMouseDown () const noexcept
 Returns whether the button click happens when the mouse is pressed or released.
 
uint32 getMillisecondsSinceButtonDown () const noexcept
 Returns the number of milliseconds since the last time the button went into the 'down' state.
 
void setTooltip (const String &newTooltip) override
 Sets the tooltip for this button.
 
void setConnectedEdges (int connectedEdgeFlags)
 Hints about which edges of the button might be connected to adjoining buttons.
 
int getConnectedEdgeFlags () const noexcept
 Returns the set of flags passed into setConnectedEdges().
 
bool isConnectedOnLeft () const noexcept
 Indicates whether the button adjoins another one on its left edge.
 
bool isConnectedOnRight () const noexcept
 Indicates whether the button adjoins another one on its right edge.
 
bool isConnectedOnTop () const noexcept
 Indicates whether the button adjoins another one on its top edge.
 
bool isConnectedOnBottom () const noexcept
 Indicates whether the button adjoins another one on its bottom edge.
 
void setState (ButtonState newState)
 Can be used to force the button into a particular state.
 
ButtonState getState () const noexcept
 Returns the button's current over/down/up state.
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component.
 
 ~Component () override
 Destructor.
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time.
 
String getName () const noexcept
 Returns the name of this component.
 
virtual void setName (const String &newName)
 Sets the name of this component.
 
String getComponentID () 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.
 
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 shouldAlsoGainKeyboardFocus)
 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.
 
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.
 
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, Rectangle< int > areaRelativeToSourceComponent) const
 Converts a rectangle to be relative to this component's coordinate space.
 
Rectangle< float > getLocalArea (const Component *sourceComponent, Rectangle< float > 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 (Rectangle< int > localArea) const
 Converts a rectangle from this component's coordinate space to a screen coordinate.
 
Rectangle< float > localAreaToGlobal (Rectangle< float > 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 (Rectangle< int > newBounds)
 Changes the component's position and size.
 
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 setBoundsRelative (Rectangle< float > proportionalArea)
 Changes the component's position and size in terms of fractions of its parent's size.
 
void setBoundsInset (BorderSize< int > borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (Rectangle< int > targetArea, 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 setCentrePosition (Point< int > newCentrePosition)
 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.
 
const Array< Component * > & getChildren () const noexcept
 Provides access to the underlying array 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 and deletes all of this component's children.
 
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 childrenChanged ()
 Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
 
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 contains (Point< float > 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.
 
bool reallyContains (Point< float > 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.
 
ComponentgetComponentAt (Point< float > 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 (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 (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.
 
bool isPaintingUnclipped () const noexcept
 Returns true if 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 methods repaint(), lookAndFeelChanged(), and colourChanged() in this component and all its children recursively.
 
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 setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the focus order of this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setFocusContainerType (FocusContainerType containerType) noexcept
 Sets whether this component is a container for components that can have their focus traversed, and the type of focus traversal that it supports.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isKeyboardFocusContainer () const noexcept
 Returns true if this component has been marked as a keyboard focus container.
 
ComponentfindFocusContainer () const
 Returns the focus container for this component.
 
ComponentfindKeyboardFocusContainer () const
 Returns the keyboard focus container for this component.
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component wants 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.
 
void giveAwayKeyboardFocus ()
 If this component or any of its children currently have the keyboard focus, this will defocus it, send a focus change notification, and try to pass the focus to the next 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 std::unique_ptr< ComponentTraversercreateFocusTraverser ()
 Creates a ComponentTraverser object to determine the logic by which focus should be passed from this component.
 
virtual std::unique_ptr< ComponentTraversercreateKeyboardFocusTraverser ()
 Creates a ComponentTraverser object to use to determine the logic by which keyboard focus should be passed from this component.
 
void setHasFocusOutline (bool hasFocusOutline) noexcept
 Use this to indicate that the component should have an outline drawn around it when it has keyboard focus.
 
bool hasFocusOutline () const noexcept
 Returns true if this component should have a focus outline.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
float getAlpha () const noexcept
 Returns the component's current transparency level.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
virtual void alphaChanged ()
 Called when setAlpha() is used to change the alpha value of this component.
 
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.
 
void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
void mouseDown (const MouseEvent &event) override
 Called when a mouse button is pressed.
 
void mouseDrag (const MouseEvent &event) override
 Called when the mouse is moved while a button is held down.
 
void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released.
 
void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
void mouseMagnify (const MouseEvent &event, float scaleFactor) override
 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 void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusGainedWithDirection (FocusChangeType cause, FocusChangeDirection direction)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 Called to indicate a change in whether or not this component is the parent of the currently-focused component.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown (bool includeChildren=false) const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging (bool includeChildren=false) 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 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.
 
int runModalLoop ()
 Runs a component modally, waiting until the loop terminates.
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Puts the component into a modal state.
 
void exitModalState (int returnValue=0)
 Ends a component's modal state.
 
bool isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) 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, or when the look-and-feel is changed by the setLookAndFeel() or sendLookAndFeelChanged() methods.
 
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().
 
void setViewportIgnoreDragFlag (bool ignoreDrag) noexcept
 Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled.
 
bool getViewportIgnoreDragFlag () const noexcept
 Retrieves the current state of the Viewport drag-to-scroll functionality flag.
 
String getTitle () const noexcept
 Returns the title text for this component.
 
void setTitle (const String &newTitle)
 Sets the title for this component.
 
String getDescription () const noexcept
 Returns the description for this component.
 
void setDescription (const String &newDescription)
 Sets the description for this component.
 
String getHelpText () const noexcept
 Returns the help text for this component.
 
void setHelpText (const String &newHelpText)
 Sets the help text for this component.
 
void setAccessible (bool shouldBeAccessible)
 Sets whether this component and its children are visible to accessibility clients.
 
bool isAccessible () const noexcept
 Returns true if this component and its children are visible to accessibility clients.
 
AccessibilityHandlergetAccessibilityHandler ()
 Returns the accessibility handler for this component, or nullptr if this component is not accessible.
 
void invalidateAccessibilityHandler ()
 Invalidates the AccessibilityHandler that is currently being used for this component.
 
- Public Member Functions inherited from MouseListener
virtual ~MouseListener ()=default
 Destructor.
 
- Public Member Functions inherited from SettableTooltipClient
 ~SettableTooltipClient () override=default
 Destructor.
 
String getTooltip () override
 Returns the tooltip assigned to this object.
 
- Public Member Functions inherited from TooltipClient
virtual ~TooltipClient ()=default
 Destructor.
 

Protected Attributes

TabbedButtonBarowner
 
int overlapPixels = 0
 
std::unique_ptr< ComponentextraComponent
 
ExtraComponentPlacement extraCompPlacement = afterText
 

Additional Inherited Members

- Static Public Member Functions inherited from Component
static float JUCE_CALLTYPE getApproximateScaleFactorForComponent (const Component *targetComponent)
 Returns the approximate scale factor for a given component by traversing its parent hierarchy and applying each transform and finally scaling this by the global scale factor.
 
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.
 
- Public Attributes inherited from Button
std::function< void()> onClick
 You can assign a lambda to this callback object to have it called when the button is clicked.
 
std::function< void()> onStateChange
 You can assign a lambda to this callback object to have it called when the button's state changes.
 
- Protected Member Functions inherited from Button
 Button (const String &buttonName)
 Creates a button.
 
virtual void buttonStateChanged ()
 Called when the button's up/down/over state changes.
 
virtual void internalClickCallback (const ModifierKeys &)
 
void handleCommandMessage (int commandId) override
 Called to handle a command that was sent by postCommandMessage().
 
void mouseEnter (const MouseEvent &) override
 Called when the mouse first enters a component.
 
void mouseExit (const MouseEvent &) override
 Called when the mouse moves out of a component.
 
void mouseDown (const MouseEvent &) override
 Called when a mouse button is pressed.
 
void mouseDrag (const MouseEvent &) override
 Called when the mouse is moved while a button is held down.
 
void mouseUp (const MouseEvent &) override
 Called when a mouse button is released.
 
bool keyPressed (const KeyPress &) override
 Called when a key is pressed.
 
void paint (Graphics &) override
 Components can override this method to draw their content.
 
void parentHierarchyChanged () override
 Called to indicate that the component's parents have changed.
 
void visibilityChanged () override
 Called when this component's visibility changes.
 
void focusGained (FocusChangeType) override
 Called to indicate that this component has just acquired the keyboard focus.
 
void focusLost (FocusChangeType) override
 Called to indicate that this component has just lost the keyboard focus.
 
void enablementChanged () override
 Callback to indicate that this component has been enabled or disabled.
 
std::unique_ptr< AccessibilityHandlercreateAccessibilityHandler () override
 Override this method to return a custom AccessibilityHandler for this component.
 
virtual bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
- Protected Member Functions inherited from SettableTooltipClient
 SettableTooltipClient ()=default
 

Detailed Description

In a TabbedButtonBar, this component is used for each of the buttons.

If you want to create a TabbedButtonBar with custom tab components, derive your component from this class, and override the TabbedButtonBar::createTabButton() method to create it instead of the default one.

See also
TabbedButtonBar

Member Enumeration Documentation

◆ ExtraComponentPlacement

When adding an extra component to the tab, this indicates which side of the text it should be placed on.

Enumerator
beforeText 
afterText 

Constructor & Destructor Documentation

◆ TabBarButton()

TabBarButton::TabBarButton ( const String & name,
TabbedButtonBar & ownerBar )

Creates the tab button.

◆ ~TabBarButton()

TabBarButton::~TabBarButton ( )
override

Destructor.

Member Function Documentation

◆ getTabbedButtonBar()

TabbedButtonBar & TabBarButton::getTabbedButtonBar ( ) const

Returns the bar that contains this button.

◆ setExtraComponent()

void TabBarButton::setExtraComponent ( Component * extraTabComponent,
ExtraComponentPlacement extraComponentPlacement )

Sets an extra component that will be shown in the tab.

This optional component will be positioned inside the tab, either to the left or right of the text. You could use this to implement things like a close button or a graphical status indicator. If a non-null component is passed-in, the TabbedButtonBar will take ownership of it and delete it when required.

◆ getExtraComponent()

Component * TabBarButton::getExtraComponent ( ) const
noexcept

Returns the custom component, if there is one.

◆ getExtraComponentPlacement()

ExtraComponentPlacement TabBarButton::getExtraComponentPlacement ( ) const
noexcept

Returns the placement of the custom component, if there is one.

◆ getActiveArea()

Rectangle< int > TabBarButton::getActiveArea ( ) const

Returns an area of the component that's safe to draw in.

This deals with the orientation of the tabs, which affects which side is touching the tabbed box's content component.

◆ getTextArea()

Rectangle< int > TabBarButton::getTextArea ( ) const

Returns the area of the component that should contain its text.

◆ getIndex()

int TabBarButton::getIndex ( ) const

Returns this tab's index in its tab bar.

◆ getTabBackgroundColour()

Colour TabBarButton::getTabBackgroundColour ( ) const

Returns the colour of the tab.

◆ isFrontTab()

bool TabBarButton::isFrontTab ( ) const

Returns true if this is the frontmost (selected) tab.

◆ getBestTabLength()

virtual int TabBarButton::getBestTabLength ( int depth)
virtual

Chooses the best length for the tab, given the specified depth.

If the tab is horizontal, this should return its width, and the depth specifies its height. If it's vertical, it should return the height, and the depth is actually its width.

◆ paintButton()

void TabBarButton::paintButton ( Graphics & g,
bool shouldDrawButtonAsHighlighted,
bool shouldDrawButtonAsDown )
overridevirtual

Subclasses should override this to actually paint the button's contents.

It's better to use this than the paint method, because it gives you information about the over/down state of the button.

Parameters
gthe graphics context to use
shouldDrawButtonAsHighlightedtrue if the button is either in the 'over' or 'down' state
shouldDrawButtonAsDowntrue if the button should be drawn in the 'down' position

Implements Button.

◆ clicked()

void TabBarButton::clicked ( const ModifierKeys & modifiers)
overridevirtual

This method is called when the button has been clicked.

By default it just calls clicked(), but you might want to override it to handle things like clicking when a modifier key is pressed, etc.

See also
ModifierKeys

Reimplemented from Button.

◆ hitTest()

bool TabBarButton::hitTest ( int x,
int y )
overridevirtual

Tests whether a given point is inside the component.

Overriding this method allows you to create components which only intercept mouse-clicks within a user-defined area.

This is called to find out whether a particular x, y coordinate is considered to be inside the component or not, and is used by methods such as contains() and getComponentAt() to work out which component the mouse is clicked on.

Components with custom shapes will probably want to override it to perform some more complex hit-testing.

The default implementation of this method returns either true or false, depending on the value that was set by calling setInterceptsMouseClicks() (true is the default return value).

Note that the hit-test region is not related to the opacity with which areas of a component are painted.

Applications should never call hitTest() directly - instead use the contains() method, because this will also test for occlusion by the component's parent.

Note that for components on the desktop, this method will be ignored, because it's not always possible to implement this behaviour on all platforms.

Parameters
xthe x coordinate to test, relative to the left hand edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's width
ythe y coordinate to test, relative to the top edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's height
Returns
true if the click is considered to be inside the component
See also
setInterceptsMouseClicks, contains

Reimplemented from Component.

◆ resized()

void TabBarButton::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 Component.

◆ childBoundsChanged()

void TabBarButton::childBoundsChanged ( Component * child)
overridevirtual

Called when one of this component's children is moved or resized.

If the parent wants to know about changes to its immediate children (not to children of its children), this is the method to override.

See also
moved, resized, parentSizeChanged

Reimplemented from Component.

Member Data Documentation

◆ owner

TabbedButtonBar& TabBarButton::owner
protected

◆ overlapPixels

int TabBarButton::overlapPixels = 0
protected

◆ extraComponent

std::unique_ptr<Component> TabBarButton::extraComponent
protected

◆ extraCompPlacement

ExtraComponentPlacement TabBarButton::extraCompPlacement = afterText
protected

The documentation for this class was generated from the following file:
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram