openshot-audio  0.1.5
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
juce::DrawableText Class Reference

#include <juce_gui_basics.h>

Inheritance diagram for juce::DrawableText:
juce::Drawable juce::Component juce::MouseListener

Classes

class  ValueTreeWrapper
 

Public Member Functions

 DrawableText ()
 
 DrawableText (const DrawableText &)
 
 ~DrawableText ()
 
void setText (const String &newText)
 
const StringgetText () const noexcept
 
void setColour (Colour newColour)
 
Colour getColour () const noexcept
 
void setFont (const Font &newFont, bool applySizeAndScale)
 
const FontgetFont () const noexcept
 
void setJustification (Justification newJustification)
 
Justification getJustification () const noexcept
 
const RelativeParallelogramgetBoundingBox () const noexcept
 
void setBoundingBox (const RelativeParallelogram &newBounds)
 
const RelativeCoordinategetFontHeight () const
 
void setFontHeight (const RelativeCoordinate &newHeight)
 
const RelativeCoordinategetFontHorizontalScale () const
 
void setFontHorizontalScale (const RelativeCoordinate &newScale)
 
void paint (Graphics &) override
 
DrawablecreateCopy () const override
 
void refreshFromValueTree (const ValueTree &tree, ComponentBuilder &builder)
 
ValueTree createValueTree (ComponentBuilder::ImageProvider *imageProvider) const override
 
Rectangle< float > getDrawableBounds () const override
 
- Public Member Functions inherited from juce::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 juce::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< 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)
 
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 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< int > getMouseXYRelative () const
 
virtual void resized ()
 
virtual void moved ()
 
virtual void childBoundsChanged (Component *child)
 
virtual void parentSizeChanged ()
 
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 Attributes

static const Identifier valueTreeType
 

Friends

class Drawable::Positioner< DrawableText >
 

Additional Inherited Members

- Public Types inherited from juce::Component
enum  FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly }
 
- Static Public Member Functions inherited from juce::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 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 inherited from juce::Drawable
 Drawable ()
 
void transformContextToCorrectOrigin (Graphics &)
 
void parentHierarchyChanged () override
 
void setBoundsToEnclose (const Rectangle< float > &)
 
 Drawable (const Drawable &)
 
- Protected Member Functions inherited from juce::Component
virtual ComponentPeercreateNewPeer (int styleFlags, void *nativeWindowToAttachTo)
 
- Protected Attributes inherited from juce::Drawable
Point< int > originRelativeToComponent
 

Detailed Description

A drawable object which renders a line of text.

See also
Drawable

Constructor & Destructor Documentation

◆ DrawableText() [1/2]

DrawableText::DrawableText ( )

Creates a DrawableText object.

◆ DrawableText() [2/2]

DrawableText::DrawableText ( const DrawableText other)

◆ ~DrawableText()

DrawableText::~DrawableText ( )

Destructor.

Member Function Documentation

◆ createCopy()

Drawable * DrawableText::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 juce::Drawable.

◆ createValueTree()

ValueTree DrawableText::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 juce::Drawable.

◆ getBoundingBox()

const RelativeParallelogram& juce::DrawableText::getBoundingBox ( ) const
inlinenoexcept

Returns the parallelogram that defines the text bounding box.

◆ getColour()

Colour juce::DrawableText::getColour ( ) const
inlinenoexcept

Returns the current text colour.

◆ getDrawableBounds()

Rectangle< float > DrawableText::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 juce::Drawable.

◆ getFont()

const Font& juce::DrawableText::getFont ( ) const
inlinenoexcept

Returns the current font.

◆ getFontHeight()

const RelativeCoordinate& juce::DrawableText::getFontHeight ( ) const
inline

◆ getFontHorizontalScale()

const RelativeCoordinate& juce::DrawableText::getFontHorizontalScale ( ) const
inline

◆ getJustification()

Justification juce::DrawableText::getJustification ( ) const
inlinenoexcept

Returns the current justification.

◆ getText()

const String& juce::DrawableText::getText ( ) const
inlinenoexcept

Returns the currently displayed text

◆ paint()

void DrawableText::paint ( Graphics g)
overridevirtual

Components can override this method to draw their content.

The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.

Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.

If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In Juce (and almost all modern UI frameworks), you never redraw something synchronously.

You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().

Parameters
gthe graphics context that must be used to do the drawing operations.
See also
repaint, paintOverChildren, Graphics

Reimplemented from juce::Component.

◆ refreshFromValueTree()

void DrawableText::refreshFromValueTree ( const ValueTree tree,
ComponentBuilder builder 
)

◆ setBoundingBox()

void DrawableText::setBoundingBox ( const RelativeParallelogram newBounds)

Sets the bounding box that contains the text.

◆ setColour()

void DrawableText::setColour ( Colour  newColour)

Sets the colour of the text.

◆ setFont()

void DrawableText::setFont ( const Font newFont,
bool  applySizeAndScale 
)

Sets the font to use. Note that the font height and horizontal scale are set as RelativeCoordinates using setFontHeight and setFontHorizontalScale. If applySizeAndScale is true, then these height and scale values will be changed to match the dimensions of the font supplied; if it is false, then the new font object's height and scale are ignored.

◆ setFontHeight()

void DrawableText::setFontHeight ( const RelativeCoordinate newHeight)

◆ setFontHorizontalScale()

void DrawableText::setFontHorizontalScale ( const RelativeCoordinate newScale)

◆ setJustification()

void DrawableText::setJustification ( Justification  newJustification)

Changes the justification of the text within the bounding box.

◆ setText()

void DrawableText::setText ( const String newText)

Sets the text to display.

Friends And Related Function Documentation

◆ Drawable::Positioner< DrawableText >

friend class Drawable::Positioner< DrawableText >
friend

Member Data Documentation

◆ valueTreeType

const Identifier DrawableText::valueTreeType
static

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