openshot-audio  0.1.6
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
DrawableComposite Class Reference

#include <juce_DrawableComposite.h>

Inheritance diagram for DrawableComposite:
Drawable Component MouseListener

Classes

class  ValueTreeWrapper
 

Public Member Functions

 DrawableComposite ()
 
 DrawableComposite (const DrawableComposite &)
 
 ~DrawableComposite ()
 
void setBoundingBox (const RelativeParallelogram &newBoundingBox)
 
const RelativeParallelogramgetBoundingBox () const noexcept
 
void resetBoundingBoxToContentArea ()
 
RelativeRectangle getContentArea () const
 
void setContentArea (const RelativeRectangle &newArea)
 
void resetContentAreaAndBoundingBoxToFitChildren ()
 
DrawablecreateCopy () const override
 
void refreshFromValueTree (const ValueTree &, ComponentBuilder &)
 
ValueTree createValueTree (ComponentBuilder::ImageProvider *imageProvider) const override
 
Rectangle< float > getDrawableBounds () const override
 
void childBoundsChanged (Component *) override
 
void childrenChanged () override
 
void parentHierarchyChanged () override
 
MarkerListgetMarkers (bool xAxis) override
 
- Public Member Functions inherited from Drawable
virtual ~Drawable ()
 
void draw (Graphics &g, float opacity, const AffineTransform &transform=AffineTransform::identity) const
 
void drawAt (Graphics &g, float x, float y, float opacity) const
 
void drawWithin (Graphics &g, const Rectangle< float > &destArea, RectanglePlacement placement, float opacity) const
 
void setOriginWithOriginalSize (Point< float > originWithinParent)
 
void setTransformToFit (const Rectangle< float > &areaInParent, RectanglePlacement placement)
 
DrawableCompositegetParent () const
 
virtual bool replaceColour (Colour originalColour, Colour replacementColour)
 
- Public Member Functions inherited from Component
 Component () noexcept
 
virtual ~Component ()
 
 Component (const String &componentName) noexcept
 
const StringgetName () const noexcept
 
virtual void setName (const String &newName)
 
const StringgetComponentID () const noexcept
 
void setComponentID (const String &newID)
 
virtual void setVisible (bool shouldBeVisible)
 
bool isVisible () const noexcept
 
virtual void visibilityChanged ()
 
bool isShowing () const
 
virtual void addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr)
 
void removeFromDesktop ()
 
bool isOnDesktop () const noexcept
 
ComponentPeergetPeer () const
 
virtual void userTriedToCloseWindow ()
 
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 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)
 
virtual void lookAndFeelChanged ()
 
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 paint (Graphics &g)
 
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 mouseDown (const MouseEvent &event) override
 
virtual void mouseDrag (const MouseEvent &event) override
 
virtual void mouseUp (const MouseEvent &event) override
 
virtual void mouseDoubleClick (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 keyPressed (const KeyPress &key)
 
virtual bool keyStateChanged (bool isKeyDown)
 
virtual void modifierKeysChanged (const ModifierKeys &modifiers)
 
virtual void focusGained (FocusChangeType cause)
 
virtual void focusLost (FocusChangeType cause)
 
virtual void focusOfChildComponentChanged (FocusChangeType cause)
 
bool isMouseOver (bool includeChildren=false) const
 
bool isMouseButtonDown () const
 
bool isMouseOverOrDragging () const
 
Point< intgetMouseXYRelative () const
 
virtual void resized ()
 
virtual void moved ()
 
virtual void parentSizeChanged ()
 
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 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 ()
 
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 ()
 

Static Public Attributes

static const char *const contentLeftMarkerName = "left"
 
static const char *const contentRightMarkerName = "right"
 
static const char *const contentTopMarkerName = "top"
 
static const char *const contentBottomMarkerName = "bottom"
 
static const Identifier valueTreeType
 

Friends

class Drawable::Positioner< DrawableComposite >
 

Additional Inherited Members

- Public Types inherited from Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 
- Static Public Member Functions inherited from Drawable
static DrawablecreateFromImageData (const void *data, size_t numBytes)
 
static DrawablecreateFromImageDataStream (InputStream &dataSource)
 
static DrawablecreateFromImageFile (const File &file)
 
static DrawablecreateFromSVG (const XmlElement &svgDocument)
 
static Path parseSVGPath (const String &svgPath)
 
static DrawablecreateFromValueTree (const ValueTree &tree, ComponentBuilder::ImageProvider *imageProvider)
 
static void registerDrawableTypeHandlers (ComponentBuilder &componentBuilder)
 
- 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 Drawable
 Drawable ()
 
void transformContextToCorrectOrigin (Graphics &)
 
void setBoundsToEnclose (const Rectangle< float > &)
 
 Drawable (const Drawable &)
 
- Protected Member Functions inherited from Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 
- Protected Attributes inherited from Drawable
Point< intoriginRelativeToComponent
 

Detailed Description

A drawable object which acts as a container for a set of other Drawables.

See also
Drawable

Constructor & Destructor Documentation

DrawableComposite::DrawableComposite ( )

Creates a composite Drawable.

DrawableComposite::DrawableComposite ( const DrawableComposite other)

Creates a copy of a DrawableComposite.

DrawableComposite::~DrawableComposite ( )

Destructor.

Member Function Documentation

void DrawableComposite::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.

void DrawableComposite::childrenChanged ( )
overridevirtual

Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.

See also
parentHierarchyChanged, ComponentListener::componentChildrenChanged

Reimplemented from Component.

Drawable * DrawableComposite::createCopy ( ) const
overridevirtual

Creates a deep copy of this Drawable object.

Use this to create a new copy of this and any sub-objects in the tree.

Implements Drawable.

ValueTree DrawableComposite::createValueTree ( ComponentBuilder::ImageProvider imageProvider) const
overridevirtual

Creates a ValueTree to represent this Drawable. The ValueTree that is returned can be turned back into a Drawable with createFromValueTree(). If there are any images used in this drawable, you'll need to provide a valid ImageProvider object that can be used to create storable representations of them.

Implements Drawable.

const RelativeParallelogram& DrawableComposite::getBoundingBox ( ) const
inlinenoexcept

Returns the parallelogram that defines the target position of the content rectangle when the drawable is rendered.

See also
setBoundingBox
RelativeRectangle DrawableComposite::getContentArea ( ) const

Returns the main content rectangle. The content area is actually defined by the markers named "left", "right", "top" and "bottom", but this method is a shortcut that returns them all at once.

See also
contentLeftMarkerName, contentRightMarkerName, contentTopMarkerName, contentBottomMarkerName
Rectangle< float > DrawableComposite::getDrawableBounds ( ) const
overridevirtual

Returns the area that this drawble covers. The result is expressed in this drawable's own coordinate space, and does not take into account any transforms that may be applied to the component.

Implements Drawable.

MarkerList * DrawableComposite::getMarkers ( bool  xAxis)
overridevirtual

Components can implement this method to provide a MarkerList. The default implementation of this method returns nullptr, but you can override it to return a pointer to the component's marker list. If xAxis is true, it should return the X marker list; if false, it should return the Y markers.

Reimplemented from Component.

void DrawableComposite::parentHierarchyChanged ( )
overridevirtual

Called to indicate that the component's parents have changed.

When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).

Subclasses can override this if they need to react to this in some way.

See also
getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged

Reimplemented from Drawable.

void DrawableComposite::refreshFromValueTree ( const ValueTree tree,
ComponentBuilder builder 
)
void DrawableComposite::resetBoundingBoxToContentArea ( )

Changes the bounding box transform to match the content area, so that any sub-items will be drawn at their untransformed positions.

void DrawableComposite::resetContentAreaAndBoundingBoxToFitChildren ( )

Resets the content area and the bounding transform to fit around the area occupied by the child components (ignoring any markers).

void DrawableComposite::setBoundingBox ( const RelativeParallelogram newBoundingBox)

Sets the parallelogram that defines the target position of the content rectangle when the drawable is rendered.

See also
setContentArea
void DrawableComposite::setContentArea ( const RelativeRectangle newArea)

Changes the main content area. The content area is actually defined by the markers named "left", "right", "top" and "bottom", but this method is a shortcut that sets them all at once.

See also
setBoundingBox, contentLeftMarkerName, contentRightMarkerName, contentTopMarkerName, contentBottomMarkerName

Friends And Related Function Documentation

friend class Drawable::Positioner< DrawableComposite >
friend

Member Data Documentation

const char *const DrawableComposite::contentBottomMarkerName = "bottom"
static

The name of the marker that defines the bottom edge of the content area.

const char *const DrawableComposite::contentLeftMarkerName = "left"
static

The name of the marker that defines the left edge of the content area.

const char *const DrawableComposite::contentRightMarkerName = "right"
static

The name of the marker that defines the right edge of the content area.

const char *const DrawableComposite::contentTopMarkerName = "top"
static

The name of the marker that defines the top edge of the content area.

const Identifier DrawableComposite::valueTreeType
static

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