openshot-audio  0.1.6
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
juce::DialogWindow Class Reference

#include <juce_gui_basics.h>

Inheritance diagram for juce::DialogWindow:
juce::DocumentWindow juce::ResizableWindow juce::TopLevelWindow juce::Component juce::MouseListener juce::DefaultDialogWindow juce::Toolbar::CustomisationDialog

Classes

struct  LaunchOptions
 

Public Member Functions

 DialogWindow (const String &name, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool addToDesktop=true)
 
 ~DialogWindow ()
 
- Public Member Functions inherited from juce::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 closeButtonPressed ()
 
virtual void minimiseButtonPressed ()
 
virtual void maximiseButtonPressed ()
 
ButtongetCloseButton () const noexcept
 
ButtongetMinimiseButton () const noexcept
 
ButtongetMaximiseButton () const noexcept
 
void paint (Graphics &) override
 
void lookAndFeelChanged () override
 
BorderSize< intgetBorderThickness () override
 
BorderSize< intgetContentComponentBorder () override
 
void mouseDoubleClick (const MouseEvent &) override
 
void userTriedToCloseWindow () override
 
void activeWindowStatusChanged () override
 
int getDesktopWindowStyleFlags () const override
 
void parentHierarchyChanged () override
 
Rectangle< intgetTitleBarArea ()
 
- Public Member Functions inherited from juce::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 juce::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 juce::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< intgetPosition () const noexcept
 
int getBottom () const noexcept
 
const Rectangle< int > & getBounds () const noexcept
 
Rectangle< intgetLocalBounds () const noexcept
 
Rectangle< intgetBoundsInParent () const noexcept
 
int getScreenX () const
 
int getScreenY () const
 
Point< intgetScreenPosition () const
 
Rectangle< intgetScreenBounds () const
 
Point< intgetLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const
 
Point< float > getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const
 
Rectangle< intgetLocalArea (const Component *sourceComponent, const Rectangle< int > &areaRelativeToSourceComponent) const
 
Point< intlocalPointToGlobal (Point< int > localPoint) const
 
Point< float > localPointToGlobal (Point< float > localPoint) const
 
Rectangle< intlocalAreaToGlobal (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< intgetParentMonitorArea () 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< intgetMouseXYRelative () const
 
virtual void broughtToFront ()
 
void addComponentListener (ComponentListener *newListener)
 
void removeComponentListener (ComponentListener *listenerToRemove)
 
void postCommandMessage (int commandId)
 
virtual void handleCommandMessage (int commandId)
 
int runModalLoop ()
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 
void exitModalState (int returnValue)
 
bool isCurrentlyModal () const noexcept
 
bool isCurrentlyBlockedByAnotherModalComponent () const
 
virtual bool canModalEventBeSentToComponent (const Component *targetComponent)
 
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 juce::MouseListener
virtual ~MouseListener ()
 

Static Public Member Functions

static void showDialog (const String &dialogTitle, Component *contentComponent, Component *componentToCentreAround, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool shouldBeResizable=false, bool useBottomRightCornerResizer=false)
 
static int showModalDialog (const String &dialogTitle, Component *contentComponent, Component *componentToCentreAround, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool shouldBeResizable=false, bool useBottomRightCornerResizer=false)
 
- Static Public Member Functions inherited from juce::TopLevelWindow
static int getNumTopLevelWindows () noexcept
 
static TopLevelWindowgetTopLevelWindow (int index) noexcept
 
static TopLevelWindowgetActiveTopLevelWindow () noexcept
 
- Static Public Member Functions inherited from juce::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

void resized () override
 
bool keyPressed (const KeyPress &) override
 
- Protected Member Functions inherited from juce::ResizableWindow
void moved () override
 
void mouseDown (const MouseEvent &) override
 
void mouseDrag (const MouseEvent &) override
 
void mouseUp (const MouseEvent &) override
 
void childBoundsChanged (Component *) override
 
void parentSizeChanged () override
 
void visibilityChanged () override
 
- Protected Member Functions inherited from juce::TopLevelWindow
void focusOfChildComponentChanged (FocusChangeType) override
 
void recreateDesktopWindow ()
 
- Protected Member Functions inherited from juce::Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 

Additional Inherited Members

- Public Types inherited from juce::DocumentWindow
enum  TitleBarButtons { minimiseButton = 1, maximiseButton = 2, closeButton = 4, allButtons = 7 }
 
enum  ColourIds { textColourId = 0x1005701 }
 
- Public Types inherited from juce::ResizableWindow
enum  ColourIds { backgroundColourId = 0x1005700 }
 
- Public Types inherited from juce::Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 
- Protected Attributes inherited from juce::ResizableWindow
ScopedPointer
< ResizableCornerComponent
resizableCorner
 
ScopedPointer
< ResizableBorderComponent
resizableBorder
 

Detailed Description

A dialog-box style window.

This class is a convenient way of creating a DocumentWindow with a close button that can be triggered by pressing the escape key.

Any of the methods available to a DocumentWindow or ResizableWindow are also available to this, so it can be made resizable, have a menu bar, etc.

You can either override or use an instance of the DialogWindow class directly, or you can use a DialogWindow::LaunchOptions structure to quickly set up and launch a box containing a content component.

If you use the class directly, you'll need to override the DocumentWindow::closeButtonPressed() method to handle the user clicking the close button - for more info, see the DocumentWindow help.

See also
DocumentWindow, ResizableWindow

Constructor & Destructor Documentation

DialogWindow::DialogWindow ( const String name,
Colour  backgroundColour,
bool  escapeKeyTriggersCloseButton,
bool  addToDesktop = true 
)

Creates a DialogWindow.

Parameters
namethe name to give the component - this is also the title shown at the top of the window. To change this later, use setName()
backgroundColourthe colour to use for filling the window's background.
escapeKeyTriggersCloseButtonif true, then pressing the escape key will cause the close button to be triggered
addToDesktopif true, the window will be automatically added to the desktop; if false, you can use it as a child component
DialogWindow::~DialogWindow ( )

Destructor. If a content component has been set with setContentOwned(), it will be deleted.

Member Function Documentation

bool DialogWindow::keyPressed ( const KeyPress key)
overrideprotectedvirtual

Called when a key is pressed.

When a key is pressed, the component that has the keyboard focus will have this method called. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.

If your implementation returns true, the event will be consumed and not passed on to any other listeners. If it returns false, the key will be passed to any KeyListeners that have been registered with this component. As soon as one of these returns true, the process will stop, but if they all return false, the event will be passed upwards to this component's parent, and so on.

The default implementation of this method does nothing and returns false.

See also
keyStateChanged, getCurrentlyFocusedComponent, addKeyListener

Reimplemented from juce::Component.

void DialogWindow::resized ( )
overrideprotectedvirtual

(if overriding this, make sure you call ResizableWindow::resized() in your subclass)

Reimplemented from juce::DocumentWindow.

void DialogWindow::showDialog ( const String dialogTitle,
Component contentComponent,
Component componentToCentreAround,
Colour  backgroundColour,
bool  escapeKeyTriggersCloseButton,
bool  shouldBeResizable = false,
bool  useBottomRightCornerResizer = false 
)
static

Easy way of quickly showing a dialog box containing a given component.

Note: this method has been superceded by the DialogWindow::LaunchOptions structure, which does the same job with some extra flexibility. The showDialog method is here for backwards compatibility, but please use DialogWindow::LaunchOptions in new code.

This will open and display a DialogWindow containing a given component, making it modal, but returning immediately to allow the dialog to finish in its own time. If you want to block and run a modal loop until the dialog is dismissed, use showModalDialog() instead.

To close the dialog programmatically, you should call exitModalState (returnValue) on the DialogWindow that is created. To find a pointer to this window from your contentComponent, you can do something like this:

if (DialogWindow* dw = contentComponent->findParentComponentOfClass<DialogWindow>())
dw->exitModalState (1234);
Parameters
dialogTitlethe dialog box's title
contentComponentthe content component for the dialog box. Make sure that this has been set to the size you want it to be before calling this method. The component won't be deleted by this call, so you can re-use it or delete it afterwards
componentToCentreAroundif this is non-zero, it indicates a component that you'd like to show this dialog box in front of. See the DocumentWindow::centreAroundComponent() method for more info on this parameter
backgroundColoura colour to use for the dialog box's background colour
escapeKeyTriggersCloseButtonif true, then pressing the escape key will cause the close button to be triggered
shouldBeResizableif true, the dialog window has either a resizable border, or a corner resizer
useBottomRightCornerResizerif shouldBeResizable is true, this indicates whether to use a border or corner resizer component. See ResizableWindow::setResizable()
int DialogWindow::showModalDialog ( const String dialogTitle,
Component contentComponent,
Component componentToCentreAround,
Colour  backgroundColour,
bool  escapeKeyTriggersCloseButton,
bool  shouldBeResizable = false,
bool  useBottomRightCornerResizer = false 
)
static

Easy way of quickly showing a dialog box containing a given component.

Note: this method has been superceded by the DialogWindow::LaunchOptions structure, which does the same job with some extra flexibility. The showDialog method is here for backwards compatibility, but please use DialogWindow::LaunchOptions in new code.

This will open and display a DialogWindow containing a given component, returning when the user clicks its close button.

It returns the value that was returned by the dialog box's runModalLoop() call.

To close the dialog programmatically, you should call exitModalState (returnValue) on the DialogWindow that is created. To find a pointer to this window from your contentComponent, you can do something like this:

if (DialogWindow* dw = contentComponent->findParentComponentOfClass<DialogWindow>())
dw->exitModalState (1234);
Parameters
dialogTitlethe dialog box's title
contentComponentthe content component for the dialog box. Make sure that this has been set to the size you want it to be before calling this method. The component won't be deleted by this call, so you can re-use it or delete it afterwards
componentToCentreAroundif this is non-zero, it indicates a component that you'd like to show this dialog box in front of. See the DocumentWindow::centreAroundComponent() method for more info on this parameter
backgroundColoura colour to use for the dialog box's background colour
escapeKeyTriggersCloseButtonif true, then pressing the escape key will cause the close button to be triggered
shouldBeResizableif true, the dialog window has either a resizable border, or a corner resizer
useBottomRightCornerResizerif shouldBeResizable is true, this indicates whether to use a border or corner resizer component. See ResizableWindow::setResizable()

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