openshot-audio  0.1.7
Classes | Public Member Functions | List of all members
Toolbar::CustomisationDialog Class Reference
Inheritance diagram for Toolbar::CustomisationDialog:
DialogWindow DocumentWindow ResizableWindow TopLevelWindow Component MouseListener

Public Member Functions

 CustomisationDialog (ToolbarItemFactory &factory, Toolbar &bar, int optionFlags)
 
 ~CustomisationDialog ()
 
void closeButtonPressed () override
 
bool canModalEventBeSentToComponent (const Component *comp) override
 
void positionNearBar ()
 
- Public Member Functions inherited from DialogWindow
 DialogWindow (const String &name, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool addToDesktop=true)
 
 ~DialogWindow ()
 
- Public Member Functions inherited from DocumentWindow
 DocumentWindow (const String &name, Colour backgroundColour, int requiredButtons, bool addToDesktop=true)
 
 ~DocumentWindow ()
 
void setName (const String &newName) override
 
void setIcon (const Image &imageToUse)
 
void setTitleBarHeight (int newHeight)
 
int getTitleBarHeight () const
 
void setTitleBarButtonsRequired (int requiredButtons, bool positionTitleBarButtonsOnLeft)
 
void setTitleBarTextCentred (bool textShouldBeCentred)
 
void setMenuBar (MenuBarModel *menuBarModel, int menuBarHeight=0)
 
ComponentgetMenuBarComponent () const noexcept
 
void setMenuBarComponent (Component *newMenuBarComponent)
 
virtual void minimiseButtonPressed ()
 
virtual void maximiseButtonPressed ()
 
ButtongetCloseButton () const noexcept
 
ButtongetMinimiseButton () const noexcept
 
ButtongetMaximiseButton () const noexcept
 
void paint (Graphics &) override
 
void resized () override
 
void lookAndFeelChanged () override
 
BorderSize< int > getBorderThickness () override
 
BorderSize< int > getContentComponentBorder () override
 
void mouseDoubleClick (const MouseEvent &) override
 
void userTriedToCloseWindow () override
 
void activeWindowStatusChanged () override
 
int getDesktopWindowStyleFlags () const override
 
void parentHierarchyChanged () override
 
Rectangle< int > getTitleBarArea ()
 
- Public Member Functions inherited from ResizableWindow
 ResizableWindow (const String &name, bool addToDesktop)
 
 ResizableWindow (const String &name, Colour backgroundColour, bool addToDesktop)
 
 ~ResizableWindow ()
 
Colour getBackgroundColour () const noexcept
 
void setBackgroundColour (Colour newColour)
 
void setResizable (bool shouldBeResizable, bool useBottomRightCornerResizer)
 
bool isResizable () const noexcept
 
void setResizeLimits (int newMinimumWidth, int newMinimumHeight, int newMaximumWidth, int newMaximumHeight) noexcept
 
void setDraggable (bool shouldBeDraggable) noexcept
 
bool isDraggable () const noexcept
 
ComponentBoundsConstrainergetConstrainer () noexcept
 
void setConstrainer (ComponentBoundsConstrainer *newConstrainer)
 
void setBoundsConstrained (const Rectangle< int > &bounds)
 
bool isFullScreen () const
 
void setFullScreen (bool shouldBeFullScreen)
 
bool isMinimised () const
 
void setMinimised (bool shouldMinimise)
 
bool isKioskMode () const
 
String getWindowStateAsString ()
 
bool restoreWindowStateFromString (const String &previousState)
 
ComponentgetContentComponent () const noexcept
 
void setContentOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
 
void setContentNonOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
 
void clearContentComponent ()
 
void setContentComponentSize (int width, int height)
 
 JUCE_DEPRECATED (void setContentComponent(Component *newContentComponent, bool deleteOldOne=true, bool resizeToFit=false))
 
- Public Member Functions inherited from TopLevelWindow
 TopLevelWindow (const String &name, bool addToDesktop)
 
 ~TopLevelWindow ()
 
bool isActiveWindow () const noexcept
 
void centreAroundComponent (Component *componentToCentreAround, int width, int height)
 
void setDropShadowEnabled (bool useShadow)
 
bool isDropShadowEnabled () const noexcept
 
void setUsingNativeTitleBar (bool useNativeTitleBar)
 
bool isUsingNativeTitleBar () const noexcept
 
void addToDesktop ()
 
void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) override
 
- Public Member Functions inherited from Component
 Component () noexcept
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
const StringgetComponentID () const noexcept
 
void setComponentID (const String &newID)
 
virtual void setVisible (bool shouldBeVisible)
 
bool isVisible () const noexcept
 
bool isShowing () const
 
void removeFromDesktop ()
 
bool isOnDesktop () const noexcept
 
ComponentPeergetPeer () const
 
virtual void minimisationStateChanged (bool isNowMinimised)
 
virtual float getDesktopScaleFactor () const
 
void toFront (bool shouldAlsoGainFocus)
 
void toBack ()
 
void toBehind (Component *other)
 
void setAlwaysOnTop (bool shouldStayOnTop)
 
bool isAlwaysOnTop () const noexcept
 
int getX () const noexcept
 
int getY () const noexcept
 
int getWidth () const noexcept
 
int getHeight () const noexcept
 
int getRight () const noexcept
 
Point< int > getPosition () const noexcept
 
int getBottom () const noexcept
 
const Rectangle< int > & getBounds () const noexcept
 
Rectangle< int > getLocalBounds () const noexcept
 
Rectangle< int > getBoundsInParent () const noexcept
 
int getScreenX () const
 
int getScreenY () const
 
Point< int > getScreenPosition () const
 
Rectangle< int > getScreenBounds () const
 
Point< int > getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 
Rectangle< int > getLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< int > localPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< int > localAreaToGlobal (const Rectangle< int > &localArea) const
 
void setTopLeftPosition (int x, int y)
 
void setTopLeftPosition (Point< int > newTopLeftPosition)
 
void setTopRightPosition (int x, int y)
 
void setSize (int newWidth, int newHeight)
 
void setBounds (int x, int y, int width, int height)
 
void setBounds (const Rectangle< int > &newBounds)
 
void setBounds (const RelativeRectangle &newBounds)
 
void setBounds (const String &newBoundsExpression)
 
void setBoundsRelative (float proportionalX, float proportionalY, float proportionalWidth, float proportionalHeight)
 
void setBoundsInset (const BorderSize< int > &borders)
 
void setBoundsToFit (int x, int y, int width, int height, Justification justification, bool onlyReduceInSize)
 
void setCentrePosition (int x, int y)
 
void setCentreRelative (float x, float y)
 
void centreWithSize (int width, int height)
 
void setTransform (const AffineTransform &transform)
 
AffineTransform getTransform () const
 
bool isTransformed () const noexcept
 
int proportionOfWidth (float proportion) const noexcept
 
int proportionOfHeight (float proportion) const noexcept
 
int getParentWidth () const noexcept
 
int getParentHeight () const noexcept
 
Rectangle< int > getParentMonitorArea () const
 
int getNumChildComponents () const noexcept
 
ComponentgetChildComponent (int index) const noexcept
 
int getIndexOfChildComponent (const Component *child) const noexcept
 
ComponentfindChildWithID (StringRef componentID) const noexcept
 
void addChildComponent (Component *child, int zOrder=-1)
 
void addChildComponent (Component &child, int zOrder=-1)
 
void addAndMakeVisible (Component *child, int zOrder=-1)
 
void addAndMakeVisible (Component &child, int zOrder=-1)
 
void addChildAndSetID (Component *child, const String &componentID)
 
void removeChildComponent (Component *childToRemove)
 
ComponentremoveChildComponent (int childIndexToRemove)
 
void removeAllChildren ()
 
void deleteAllChildren ()
 
ComponentgetParentComponent () const noexcept
 
template<class TargetClass >
TargetClass * findParentComponentOfClass () const
 
ComponentgetTopLevelComponent () const noexcept
 
bool isParentOf (const Component *possibleChild) const noexcept
 
virtual void childrenChanged ()
 
virtual bool hitTest (int x, int y)
 
void setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept
 
void getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept
 
bool contains (Point< int > localPoint)
 
bool reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild)
 
ComponentgetComponentAt (int x, int y)
 
ComponentgetComponentAt (Point< int > position)
 
void repaint ()
 
void repaint (int x, int y, int width, int height)
 
void repaint (const Rectangle< int > &area)
 
void setBufferedToImage (bool shouldBeBuffered)
 
Image createComponentSnapshot (const Rectangle< int > &areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f)
 
void paintEntireComponent (Graphics &context, bool ignoreAlphaLevel)
 
void setPaintingIsUnclipped (bool shouldPaintWithoutClipping) noexcept
 
void setComponentEffect (ImageEffectFilter *newEffect)
 
ImageEffectFiltergetComponentEffect () const noexcept
 
LookAndFeelgetLookAndFeel () const noexcept
 
void setLookAndFeel (LookAndFeel *newLookAndFeel)
 
void sendLookAndFeelChange ()
 
void setOpaque (bool shouldBeOpaque)
 
bool isOpaque () const noexcept
 
void setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept
 
bool isBroughtToFrontOnMouseClick () const noexcept
 
void setWantsKeyboardFocus (bool wantsFocus) noexcept
 
bool getWantsKeyboardFocus () const noexcept
 
void setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus)
 
bool getMouseClickGrabsKeyboardFocus () const noexcept
 
void grabKeyboardFocus ()
 
bool hasKeyboardFocus (bool trueIfChildIsFocused) const
 
void moveKeyboardFocusToSibling (bool moveToNext)
 
virtual KeyboardFocusTraversercreateFocusTraverser ()
 
int getExplicitFocusOrder () const
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 
bool isFocusContainer () const noexcept
 
bool isEnabled () const noexcept
 
void setEnabled (bool shouldBeEnabled)
 
virtual void enablementChanged ()
 
void setAlpha (float newAlpha)
 
float getAlpha () const
 
void setMouseCursor (const MouseCursor &cursorType)
 
virtual MouseCursor getMouseCursor ()
 
void updateMouseCursor () const
 
virtual void paintOverChildren (Graphics &g)
 
virtual void mouseMove (const MouseEvent &event) override
 
virtual void mouseEnter (const MouseEvent &event) override
 
virtual void mouseExit (const MouseEvent &event) override
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 
void setRepaintsOnMouseActivity (bool shouldRepaint) noexcept
 
void addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents)
 
void removeMouseListener (MouseListener *listenerToRemove)
 
void addKeyListener (KeyListener *newListener)
 
void removeKeyListener (KeyListener *listenerToRemove)
 
virtual bool keyStateChanged (bool isKeyDown)
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 
virtual void focusGained (FocusChangeType cause)
 
virtual void focusLost (FocusChangeType cause)
 
bool isMouseOver (bool includeChildren=false) const
 
bool isMouseButtonDown () const
 
bool isMouseOverOrDragging () const
 
Point< int > getMouseXYRelative () const
 
virtual void broughtToFront ()
 
void addComponentListener (ComponentListener *newListener)
 
void removeComponentListener (ComponentListener *listenerToRemove)
 
void postCommandMessage (int commandId)
 
virtual void handleCommandMessage (int commandId)
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 
void exitModalState (int returnValue)
 
bool isCurrentlyModal () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual void inputAttemptWhenModal ()
 
NamedValueSetgetProperties () noexcept
 
const NamedValueSetgetProperties () const noexcept
 
Colour findColour (int colourId, bool inheritFromParent=false) const
 
void setColour (int colourId, Colour newColour)
 
void removeColour (int colourId)
 
bool isColourSpecified (int colourId) const
 
void copyAllExplicitColoursTo (Component &target) const
 
virtual void colourChanged ()
 
virtual MarkerListgetMarkers (bool xAxis)
 
void * getWindowHandle () const
 
PositionergetPositioner () const noexcept
 
void setPositioner (Positioner *newPositioner)
 
void setCachedComponentImage (CachedComponentImage *newCachedImage)
 
CachedComponentImagegetCachedComponentImage () const noexcept
 
 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 ()
 

Additional Inherited Members

- Public Types inherited from DocumentWindow
enum  TitleBarButtons { minimiseButton = 1, maximiseButton = 2, closeButton = 4, allButtons = 7 }
 
enum  ColourIds { textColourId = 0x1005701 }
 
- Public Types inherited from ResizableWindow
enum  ColourIds { backgroundColourId = 0x1005700 }
 
- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 
- Static Public Member Functions inherited from DialogWindow
static void showDialog (const String &dialogTitle, Component *contentComponent, Component *componentToCentreAround, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool shouldBeResizable=false, bool useBottomRightCornerResizer=false)
 
- Static Public Member Functions inherited from TopLevelWindow
static int getNumTopLevelWindows () noexcept
 
static TopLevelWindowgetTopLevelWindow (int index) noexcept
 
static TopLevelWindowgetActiveTopLevelWindow () noexcept
 
- Static Public Member Functions inherited from Component
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
 
- Protected Member Functions inherited from DialogWindow
void resized () override
 
bool keyPressed (const KeyPress &) override
 
- Protected Member Functions inherited from ResizableWindow
void paint (Graphics &) override
 
void moved () override
 
void resized () override
 
void mouseDown (const MouseEvent &) override
 
void mouseDrag (const MouseEvent &) override
 
void mouseUp (const MouseEvent &) override
 
void lookAndFeelChanged () override
 
void childBoundsChanged (Component *) override
 
void parentSizeChanged () override
 
void visibilityChanged () override
 
void activeWindowStatusChanged () override
 
int getDesktopWindowStyleFlags () const override
 
- Protected Member Functions inherited from TopLevelWindow
void focusOfChildComponentChanged (FocusChangeType) override
 
void parentHierarchyChanged () override
 
void recreateDesktopWindow ()
 
void visibilityChanged () override
 
- Protected Member Functions inherited from Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 
- Protected Attributes inherited from ResizableWindow
ScopedPointer< ResizableCornerComponentresizableCorner
 
ScopedPointer< ResizableBorderComponentresizableBorder
 

Constructor & Destructor Documentation

◆ CustomisationDialog()

Toolbar::CustomisationDialog::CustomisationDialog ( ToolbarItemFactory factory,
Toolbar bar,
int  optionFlags 
)
inline

◆ ~CustomisationDialog()

Toolbar::CustomisationDialog::~CustomisationDialog ( )
inline

Member Function Documentation

◆ canModalEventBeSentToComponent()

bool Toolbar::CustomisationDialog::canModalEventBeSentToComponent ( const Component targetComponent)
inlineoverridevirtual

When a component is modal, this callback allows it to choose which other components can still receive events.

When a modal component is active and the user clicks on a non-modal component, this method is called on the modal component, and if it returns true, the event is allowed to reach its target. If it returns false, the event is blocked and the inputAttemptWhenModal() callback is made.

It called by the isCurrentlyBlockedByAnotherModalComponent() method. The default implementation just returns false in all cases.

Reimplemented from Component.

◆ closeButtonPressed()

void Toolbar::CustomisationDialog::closeButtonPressed ( )
inlineoverridevirtual

This method is called when the user tries to close the window.

This is triggered by the user clicking the close button, or using some other OS-specific key shortcut or OS menu for getting rid of a window.

If the window is just a pop-up, you should override this closeButtonPressed() method and make it delete the window in whatever way is appropriate for your app. E.g. you might just want to call "delete this".

If your app is centred around this window such that the whole app should quit when the window is closed, then you will probably want to use this method as an opportunity to call JUCEApplicationBase::quit(), and leave the window to be deleted later by your JUCEApplicationBase::shutdown() method. (Doing it this way means that your window will still get cleaned-up if the app is quit by some other means (e.g. a cmd-Q on the mac or closing it via the taskbar icon on Windows).

(Note that the DocumentWindow class overrides Component::userTriedToCloseWindow() and redirects it to call this method, so any methods of closing the window that are caught by userTriedToCloseWindow() will also end up here).

Reimplemented from DocumentWindow.

◆ positionNearBar()

void Toolbar::CustomisationDialog::positionNearBar ( )
inline

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