JUCE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
DialogWindow Class Reference

A dialog-box style window. More...

Inherits DocumentWindow.

Classes

struct  LaunchOptions
 This class defines a collection of settings to be used to open a DialogWindow. More...
 

Public Member Functions

 DialogWindow (const String &name, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool addToDesktop=true)
 Creates a DialogWindow.
 
 ~DialogWindow ()
 Destructor.
 
- Public Member Functions inherited from DocumentWindow
 DocumentWindow (const String &name, Colour backgroundColour, int requiredButtons, bool addToDesktop=true)
 Creates a DocumentWindow.
 
 ~DocumentWindow ()
 Destructor.
 
void setName (const String &newName)
 Changes the component's name.
 
void setIcon (const Image &imageToUse)
 Sets an icon to show in the title bar, next to the title.
 
void setTitleBarHeight (int newHeight)
 Changes the height of the title-bar.
 
int getTitleBarHeight () const
 Returns the current title bar height.
 
void setTitleBarButtonsRequired (int requiredButtons, bool positionTitleBarButtonsOnLeft)
 Changes the set of title-bar buttons being shown.
 
void setTitleBarTextCentred (bool textShouldBeCentred)
 Sets whether the title should be centred within the window.
 
void setMenuBar (MenuBarModel *menuBarModel, int menuBarHeight=0)
 Creates a menu inside this window.
 
ComponentgetMenuBarComponent () const noexcept
 Returns the current menu bar component, or null if there isn't one.
 
void setMenuBarComponent (Component *newMenuBarComponent)
 Replaces the current menu bar with a custom component.
 
virtual void closeButtonPressed ()
 This method is called when the user tries to close the window.
 
virtual void minimiseButtonPressed ()
 Callback that is triggered when the minimise button is pressed.
 
virtual void maximiseButtonPressed ()
 Callback that is triggered when the maximise button is pressed, or when the title-bar is double-clicked.
 
ButtongetCloseButton () const noexcept
 Returns the close button, (or nullptr if there isn't one).
 
ButtongetMinimiseButton () const noexcept
 Returns the minimise button, (or nullptr if there isn't one).
 
ButtongetMaximiseButton () const noexcept
 Returns the maximise button, (or nullptr if there isn't one).
 
- Public Member Functions inherited from ResizableWindow
 ResizableWindow (const String &name, bool addToDesktop)
 Creates a ResizableWindow.
 
 ResizableWindow (const String &name, Colour backgroundColour, bool addToDesktop)
 Creates a ResizableWindow.
 
 ~ResizableWindow ()
 Destructor.
 
Colour getBackgroundColour () const noexcept
 Returns the colour currently being used for the window's background.
 
void setBackgroundColour (Colour newColour)
 Changes the colour currently being used for the window's background.
 
void setResizable (bool shouldBeResizable, bool useBottomRightCornerResizer)
 Make the window resizable or fixed.
 
bool isResizable () const noexcept
 Returns true if resizing is enabled.
 
void setResizeLimits (int newMinimumWidth, int newMinimumHeight, int newMaximumWidth, int newMaximumHeight) noexcept
 This sets the maximum and minimum sizes for the window.
 
ComponentBoundsConstrainergetConstrainer () noexcept
 Returns the bounds constrainer object that this window is using.
 
void setConstrainer (ComponentBoundsConstrainer *newConstrainer)
 Sets the bounds-constrainer object to use for resizing and dragging this window.
 
void setBoundsConstrained (const Rectangle< int > &bounds)
 Calls the window's setBounds method, after first checking these bounds with the current constrainer.
 
bool isFullScreen () const
 Returns true if the window is currently in full-screen mode.
 
void setFullScreen (bool shouldBeFullScreen)
 Puts the window into full-screen mode, or restores it to its normal size.
 
bool isMinimised () const
 Returns true if the window is currently minimised.
 
void setMinimised (bool shouldMinimise)
 Minimises the window, or restores it to its previous position and size.
 
bool isKioskMode () const
 Returns true if the window has been placed in kiosk-mode.
 
String getWindowStateAsString ()
 Returns a string which encodes the window's current size and position.
 
bool restoreWindowStateFromString (const String &previousState)
 Restores the window to a previously-saved size and position.
 
ComponentgetContentComponent () const noexcept
 Returns the current content component.
 
void setContentOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
 Changes the current content component.
 
void setContentNonOwned (Component *newContentComponent, bool resizeToFitWhenContentChangesSize)
 Changes the current content component.
 
void clearContentComponent ()
 Removes the current content component.
 
void setContentComponentSize (int width, int height)
 Changes the window so that the content component ends up with the specified size.
 
virtual BorderSize< int > getBorderThickness ()
 Returns the width of the frame to use around the window.
 
virtual BorderSize< int > getContentComponentBorder ()
 Returns the insets to use when positioning the content component.
 
 JUCE_DEPRECATED (void setContentComponent(Component *newContentComponent, bool deleteOldOne=true, bool resizeToFit=false))
 
- Public Member Functions inherited from TopLevelWindow
 TopLevelWindow (const String &name, bool addToDesktop)
 Creates a TopLevelWindow.
 
 ~TopLevelWindow ()
 Destructor.
 
bool isActiveWindow () const noexcept
 True if this is currently the TopLevelWindow that is actively being used.
 
void centreAroundComponent (Component *componentToCentreAround, int width, int height)
 This will set the bounds of the window so that it's centred in front of another window.
 
void setDropShadowEnabled (bool useShadow)
 Turns the drop-shadow on and off.
 
bool isDropShadowEnabled () const noexcept
 True if drop-shadowing is enabled.
 
void setUsingNativeTitleBar (bool useNativeTitleBar)
 Sets whether an OS-native title bar will be used, or a Juce one.
 
bool isUsingNativeTitleBar () const noexcept
 Returns true if the window is currently using an OS-native title bar.
 
void addToDesktop ()
 Adds the window to the desktop using the default flags.
 
void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) override
 
- Public Member Functions inherited from Component
 Component () noexcept
 Creates a component.
 
virtual ~Component ()
 Destructor.
 
 Component (const String &componentName) noexcept
 Creates a component, setting its name at the same time.
 
const StringgetName () const noexcept
 Returns the name of this component.
 
const StringgetComponentID () 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.
 
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 shouldAlsoGainFocus)
 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.
 
const 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, const Rectangle< int > &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 (const Rectangle< int > &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 (const Rectangle< int > &newBounds)
 Changes the component's position and size.
 
void setBounds (const RelativeRectangle &newBounds)
 Changes the component's position and size.
 
void setBounds (const String &newBoundsExpression)
 Sets the component's bounds with an expression.
 
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 setBoundsInset (const BorderSize< int > &borders)
 Changes the component's position and size based on the amount of space to leave around it.
 
void setBoundsToFit (int x, int y, int width, int height, 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 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.
 
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 all this component's children, and deletes them.
 
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.
 
virtual bool hitTest (int x, int y)
 Tests whether a given point inside the component.
 
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 reallyContains (Point< int > 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.
 
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 (const 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 (const 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.
 
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.
 
void sendLookAndFeelChange ()
 Calls the lookAndFeelChanged() method in this component and all its children.
 
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 setWantsKeyboardFocus (bool wantsFocus) noexcept
 Sets a flag to indicate whether this component needs 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.
 
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 KeyboardFocusTraversercreateFocusTraverser ()
 Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
 
int getExplicitFocusOrder () const
 Returns the focus order of this component, if one has been specified.
 
void setExplicitFocusOrder (int newFocusOrderIndex)
 Sets the index used in determining the order in which focusable components should be traversed.
 
void setFocusContainer (bool shouldBeFocusContainer) noexcept
 Indicates whether this component is a parent for components that can have their focus traversed.
 
bool isFocusContainer () const noexcept
 Returns true if this component has been marked as a focus container.
 
bool isEnabled () const noexcept
 Returns true if the component (and all its parents) are enabled.
 
void setEnabled (bool shouldBeEnabled)
 Enables or disables this component.
 
virtual void enablementChanged ()
 Callback to indicate that this component has been enabled or disabled.
 
void setAlpha (float newAlpha)
 Changes the transparency of this component.
 
float getAlpha () const
 Returns the component's current transparancy level.
 
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.
 
virtual void mouseMove (const MouseEvent &event) override
 Called when the mouse moves inside a component.
 
virtual void mouseEnter (const MouseEvent &event) override
 Called when the mouse first enters a component.
 
virtual void mouseExit (const MouseEvent &event) override
 Called when the mouse moves out of a component.
 
virtual void mouseUp (const MouseEvent &event) override
 Called when a mouse button is released.
 
virtual void mouseDoubleClick (const MouseEvent &event) override
 Called when a mouse button has been double-clicked on a component.
 
virtual void mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override
 Called when the mouse-wheel is moved.
 
virtual void mouseMagnify (const MouseEvent &event, float scaleFactor)
 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 bool keyStateChanged (bool isKeyDown)
 Called when a key is pressed or released.
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 Called when a modifier key is pressed or released.
 
virtual void focusGained (FocusChangeType cause)
 Called to indicate that this component has just acquired the keyboard focus.
 
virtual void focusLost (FocusChangeType cause)
 Called to indicate that this component has just lost the keyboard focus.
 
bool isMouseOver (bool includeChildren=false) const
 Returns true if the mouse is currently over this component.
 
bool isMouseButtonDown () const
 Returns true if the mouse button is currently held down in this component.
 
bool isMouseOverOrDragging () 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 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.
 
virtual void handleCommandMessage (int commandId)
 Called to handle a command that was sent by postCommandMessage().
 
void enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false)
 Runs a component modally, waiting until the loop terminates.
 
void exitModalState (int returnValue)
 Ends a component's modal state.
 
bool isCurrentlyModal () 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.
 
virtual MarkerListgetMarkers (bool xAxis)
 Components can implement this method to provide a MarkerList.
 
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().
 
 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 ()
 Destructor.
 

Static Public Member Functions

static void showDialog (const String &dialogTitle, Component *contentComponent, Component *componentToCentreAround, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool shouldBeResizable=false, bool useBottomRightCornerResizer=false)
 Easy way of quickly showing a dialog box containing a given component.
 
static int showModalDialog (const String &dialogTitle, Component *contentComponent, Component *componentToCentreAround, Colour backgroundColour, bool escapeKeyTriggersCloseButton, bool shouldBeResizable=false, bool useBottomRightCornerResizer=false)
 Easy way of quickly showing a dialog box containing a given component.
 

Protected Member Functions

void resized () override
 
bool keyPressed (const KeyPress &) override
 

Additional Inherited Members

- Public Types inherited from DocumentWindow
enum  TitleBarButtons { minimiseButton = 1, maximiseButton = 2, closeButton = 4, allButtons = 7 }
 The set of available button-types that can be put on the title bar. More...
 
enum  ColourIds { textColourId = 0x1005701 }
 A set of colour IDs to use to change the colour of various aspects of the window. More...
 
- Protected Attributes inherited from 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

static 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:

Dialogwindow* dw = contentComponent->findParentComponentOfClass<DialogWindow>();
if (dw != nullptr)
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()
static 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:

Dialogwindow* dw = contentComponent->findParentComponentOfClass<DialogWindow>();
if (dw != nullptr)
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()
void DialogWindow::resized ( )
overrideprotectedvirtual

Reimplemented from Component.

bool DialogWindow::keyPressed ( const KeyPress )
overrideprotectedvirtual

Reimplemented from Component.


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