|
| TextEditor (const String &componentName=String(), juce_wchar passwordCharacter=0) |
| Creates a new, empty text editor. More...
|
|
| ~TextEditor () override |
| Destructor. More...
|
|
void | setMultiLine (bool shouldBeMultiLine, bool shouldWordWrap=true) |
| Puts the editor into either multi- or single-line mode. More...
|
|
bool | isMultiLine () const |
| Returns true if the editor is in multi-line mode. More...
|
|
void | setReturnKeyStartsNewLine (bool shouldStartNewLine) |
| Changes the behaviour of the return key. More...
|
|
bool | getReturnKeyStartsNewLine () const |
| Returns the value set by setReturnKeyStartsNewLine(). More...
|
|
void | setTabKeyUsedAsCharacter (bool shouldTabKeyBeUsed) |
| Indicates whether the tab key should be accepted and used to input a tab character, or whether it gets ignored. More...
|
|
bool | isTabKeyUsedAsCharacter () const |
| Returns true if the tab key is being used for input. More...
|
|
void | setEscapeAndReturnKeysConsumed (bool shouldBeConsumed) noexcept |
| This can be used to change whether escape and return keypress events are propagated up to the parent component. More...
|
|
void | setReadOnly (bool shouldBeReadOnly) |
| Changes the editor to read-only mode. More...
|
|
bool | isReadOnly () const noexcept |
| Returns true if the editor is in read-only mode. More...
|
|
void | setCaretVisible (bool shouldBeVisible) |
| Makes the caret visible or invisible. More...
|
|
bool | isCaretVisible () const noexcept |
| Returns true if the caret is enabled. More...
|
|
void | setScrollbarsShown (bool shouldBeEnabled) |
| Enables or disables scrollbars (this only applies when in multi-line mode). More...
|
|
bool | areScrollbarsShown () const noexcept |
| Returns true if scrollbars are enabled. More...
|
|
void | setPasswordCharacter (juce_wchar passwordCharacter) |
| Changes the password character used to disguise the text. More...
|
|
juce_wchar | getPasswordCharacter () const noexcept |
| Returns the current password character. More...
|
|
void | setPopupMenuEnabled (bool menuEnabled) |
| Allows a right-click menu to appear for the editor. More...
|
|
bool | isPopupMenuEnabled () const noexcept |
| Returns true if the right-click menu is enabled. More...
|
|
bool | isPopupMenuCurrentlyActive () const noexcept |
| Returns true if a popup-menu is currently being displayed. More...
|
|
void | setFont (const Font &newFont) |
| Sets the font to use for newly added text. More...
|
|
void | applyFontToAllText (const Font &newFont, bool changeCurrentFont=true) |
| Applies a font to all the text in the editor. More...
|
|
const Font & | getFont () const noexcept |
| Returns the font that's currently being used for new text. More...
|
|
void | applyColourToAllText (const Colour &newColour, bool changeCurrentTextColour=true) |
| Applies a colour to all the text in the editor. More...
|
|
void | setWhitespaceUnderlined (bool shouldUnderlineWhitespace) noexcept |
| Sets whether whitespace should be underlined when the editor font is underlined. More...
|
|
bool | isWhitespaceUnderlined () const noexcept |
| Returns true if whitespace is underlined for underlined fonts. More...
|
|
void | setSelectAllWhenFocused (bool shouldSelectAll) |
| If set to true, focusing on the editor will highlight all its text. More...
|
|
void | setTextToShowWhenEmpty (const String &text, Colour colourToUse) |
| When the text editor is empty, it can be set to display a message. More...
|
|
String | getTextToShowWhenEmpty () const noexcept |
| Returns the text that will be shown when the text editor is empty. More...
|
|
void | setScrollBarThickness (int newThicknessPixels) |
| Changes the size of the scrollbars that are used. More...
|
|
void | addListener (Listener *newListener) |
| Registers a listener to be told when things happen to the text. More...
|
|
void | removeListener (Listener *listenerToRemove) |
| Deregisters a listener. More...
|
|
String | getText () const |
| Returns the entire contents of the editor. More...
|
|
String | getTextInRange (const Range< int > &textRange) const override |
| Returns a section of the contents of the editor. More...
|
|
bool | isEmpty () const |
| Returns true if there are no characters in the editor. More...
|
|
void | setText (const String &newText, bool sendTextChangeMessage=true) |
| Sets the entire content of the editor. More...
|
|
Value & | getTextValue () |
| Returns a Value object that can be used to get or set the text. More...
|
|
void | insertTextAtCaret (const String &textToInsert) override |
| Inserts some text at the current caret position. More...
|
|
void | clear () |
| Deletes all the text from the editor. More...
|
|
void | cut () |
| Deletes the currently selected region. More...
|
|
void | copy () |
| Copies the currently selected region to the clipboard. More...
|
|
void | paste () |
| Pastes the contents of the clipboard into the editor at the caret position. More...
|
|
int | getCaretPosition () const |
| Returns the current index of the caret. More...
|
|
void | setCaretPosition (int newIndex) |
| Moves the caret to be in front of a given character. More...
|
|
void | scrollEditorToPositionCaret (int desiredCaretX, int desiredCaretY) |
| Attempts to scroll the text editor so that the caret ends up at a specified position. More...
|
|
Rectangle< int > | getCaretRectangle () override |
| Get the graphical position of the caret. More...
|
|
void | setHighlightedRegion (const Range< int > &newSelection) override |
| Selects a section of the text. More...
|
|
Range< int > | getHighlightedRegion () const override |
| Returns the range of characters that are selected. More...
|
|
String | getHighlightedText () const |
| Returns the section of text that is currently selected. More...
|
|
int | getTextIndexAt (int x, int y) const |
| Finds the index of the character at a given position. More...
|
|
int | getTotalNumChars () const |
| Counts the number of characters in the text. More...
|
|
int | getTextWidth () const |
| Returns the total width of the text, as it is currently laid-out. More...
|
|
int | getTextHeight () const |
| Returns the maximum height of the text, as it is currently laid-out. More...
|
|
void | setIndents (int newLeftIndent, int newTopIndent) |
| Changes the size of the gap at the top and left-edge of the editor. More...
|
|
int | getTopIndent () const noexcept |
| Returns the gap at the top edge of the editor. More...
|
|
int | getLeftIndent () const noexcept |
| Returns the gap at the left edge of the editor. More...
|
|
void | setBorder (BorderSize< int > border) |
| Changes the size of border left around the edge of the component. More...
|
|
BorderSize< int > | getBorder () const |
| Returns the size of border around the edge of the component. More...
|
|
void | setScrollToShowCursor (bool shouldScrollToShowCaret) |
| Used to disable the auto-scrolling which keeps the caret visible. More...
|
|
void | setJustification (Justification newJustification) |
| Modifies the justification of the text within the editor window. More...
|
|
Justification | getJustificationType () const noexcept |
| Returns the type of justification, as set in setJustification(). More...
|
|
void | setLineSpacing (float newLineSpacing) noexcept |
| Sets the line spacing of the TextEditor. More...
|
|
float | getLineSpacing () const noexcept |
| Returns the current line spacing of the TextEditor. More...
|
|
RectangleList< int > | getTextBounds (Range< int > textRange) |
| Returns the bounding box for a range of text in the editor. More...
|
|
void | moveCaretToEnd () |
|
bool | moveCaretLeft (bool moveInWholeWordSteps, bool selecting) |
|
bool | moveCaretRight (bool moveInWholeWordSteps, bool selecting) |
|
bool | moveCaretUp (bool selecting) |
|
bool | moveCaretDown (bool selecting) |
|
bool | pageUp (bool selecting) |
|
bool | pageDown (bool selecting) |
|
bool | scrollDown () |
|
bool | scrollUp () |
|
bool | moveCaretToTop (bool selecting) |
|
bool | moveCaretToStartOfLine (bool selecting) |
|
bool | moveCaretToEnd (bool selecting) |
|
bool | moveCaretToEndOfLine (bool selecting) |
|
bool | deleteBackwards (bool moveInWholeWordSteps) |
|
bool | deleteForwards (bool moveInWholeWordSteps) |
|
bool | copyToClipboard () |
|
bool | cutToClipboard () |
|
bool | pasteFromClipboard () |
|
bool | selectAll () |
|
bool | undo () |
|
bool | redo () |
|
virtual void | addPopupMenuItems (PopupMenu &menuToAddTo, const MouseEvent *mouseClickEvent) |
| This adds the items to the popup menu. More...
|
|
virtual void | performPopupMenuAction (int menuItemID) |
| This is called to perform one of the items that was shown on the popup menu. More...
|
|
void | setInputFilter (InputFilter *newFilter, bool takeOwnership) |
| Sets an input filter that should be applied to this editor. More...
|
|
InputFilter * | getInputFilter () const noexcept |
| Returns the current InputFilter, as set by setInputFilter(). More...
|
|
void | setInputRestrictions (int maxTextLength, const String &allowedCharacters=String()) |
| Sets limits on the characters that can be entered. More...
|
|
void | setKeyboardType (VirtualKeyboardType type) noexcept |
|
void | paint (Graphics &) override |
|
void | paintOverChildren (Graphics &) override |
|
void | mouseDown (const MouseEvent &) override |
|
void | mouseUp (const MouseEvent &) override |
|
void | mouseDrag (const MouseEvent &) override |
|
void | mouseDoubleClick (const MouseEvent &) override |
|
void | mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override |
|
bool | keyPressed (const KeyPress &) override |
|
bool | keyStateChanged (bool) override |
|
void | focusGained (FocusChangeType) override |
|
void | focusLost (FocusChangeType) override |
|
void | resized () override |
|
void | enablementChanged () override |
|
void | lookAndFeelChanged () override |
|
void | parentHierarchyChanged () override |
|
bool | isTextInputActive () const override |
|
void | setTemporaryUnderlining (const Array< Range< int > > &) override |
|
VirtualKeyboardType | getKeyboardType () override |
|
| Component () noexcept |
| Creates a component. More...
|
|
| ~Component () override |
| Destructor. More...
|
|
| Component (const String &componentName) noexcept |
| Creates a component, setting its name at the same time. More...
|
|
String | getName () const noexcept |
| Returns the name of this component. More...
|
|
virtual void | setName (const String &newName) |
| Sets the name of this component. More...
|
|
String | getComponentID () const noexcept |
| Returns the ID string that was set by setComponentID(). More...
|
|
void | setComponentID (const String &newID) |
| Sets the component's ID string. More...
|
|
virtual void | setVisible (bool shouldBeVisible) |
| Makes the component visible or invisible. More...
|
|
bool | isVisible () const noexcept |
| Tests whether the component is visible or not. More...
|
|
virtual void | visibilityChanged () |
| Called when this component's visibility changes. More...
|
|
bool | isShowing () const |
| Tests whether this component and all its parents are visible. More...
|
|
virtual void | addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) |
| Makes this component appear as a window on the desktop. More...
|
|
void | removeFromDesktop () |
| If the component is currently showing on the desktop, this will hide it. More...
|
|
bool | isOnDesktop () const noexcept |
| Returns true if this component is currently showing on the desktop. More...
|
|
ComponentPeer * | getPeer () const |
| Returns the heavyweight window that contains this component. More...
|
|
virtual void | userTriedToCloseWindow () |
| For components on the desktop, this is called if the system wants to close the window. More...
|
|
virtual void | minimisationStateChanged (bool isNowMinimised) |
| Called for a desktop component which has just been minimised or un-minimised. More...
|
|
virtual float | getDesktopScaleFactor () const |
| Returns the default scale factor to use for this component when it is placed on the desktop. More...
|
|
void | toFront (bool shouldAlsoGainKeyboardFocus) |
| Brings the component to the front of its siblings. More...
|
|
void | toBack () |
| Changes this component's z-order to be at the back of all its siblings. More...
|
|
void | toBehind (Component *other) |
| Changes this component's z-order so that it's just behind another component. More...
|
|
void | setAlwaysOnTop (bool shouldStayOnTop) |
| Sets whether the component should always be kept at the front of its siblings. More...
|
|
bool | isAlwaysOnTop () const noexcept |
| Returns true if this component is set to always stay in front of its siblings. More...
|
|
int | getX () const noexcept |
| Returns the x coordinate of the component's left edge. More...
|
|
int | getY () const noexcept |
| Returns the y coordinate of the top of this component. More...
|
|
int | getWidth () const noexcept |
| Returns the component's width in pixels. More...
|
|
int | getHeight () const noexcept |
| Returns the component's height in pixels. More...
|
|
int | getRight () const noexcept |
| Returns the x coordinate of the component's right-hand edge. More...
|
|
Point< int > | getPosition () const noexcept |
| Returns the component's top-left position as a Point. More...
|
|
int | getBottom () const noexcept |
| Returns the y coordinate of the bottom edge of this component. More...
|
|
Rectangle< int > | getBounds () const noexcept |
| Returns this component's bounding box. More...
|
|
Rectangle< int > | getLocalBounds () const noexcept |
| Returns the component's bounds, relative to its own origin. More...
|
|
Rectangle< int > | getBoundsInParent () const noexcept |
| Returns the area of this component's parent which this component covers. More...
|
|
int | getScreenX () const |
| Returns this component's x coordinate relative the screen's top-left origin. More...
|
|
int | getScreenY () const |
| Returns this component's y coordinate relative the screen's top-left origin. More...
|
|
Point< int > | getScreenPosition () const |
| Returns the position of this component's top-left corner relative to the screen's top-left. More...
|
|
Rectangle< int > | getScreenBounds () const |
| Returns the bounds of this component, relative to the screen's top-left. More...
|
|
Point< int > | getLocalPoint (const Component *sourceComponent, Point< int > pointRelativeToSourceComponent) const |
| Converts a point to be relative to this component's coordinate space. More...
|
|
Point< float > | getLocalPoint (const Component *sourceComponent, Point< float > pointRelativeToSourceComponent) const |
| Converts a point to be relative to this component's coordinate space. More...
|
|
Rectangle< int > | getLocalArea (const Component *sourceComponent, Rectangle< int > areaRelativeToSourceComponent) const |
| Converts a rectangle to be relative to this component's coordinate space. More...
|
|
Rectangle< float > | getLocalArea (const Component *sourceComponent, Rectangle< float > areaRelativeToSourceComponent) const |
| Converts a rectangle to be relative to this component's coordinate space. More...
|
|
Point< int > | localPointToGlobal (Point< int > localPoint) const |
| Converts a point relative to this component's top-left into a screen coordinate. More...
|
|
Point< float > | localPointToGlobal (Point< float > localPoint) const |
| Converts a point relative to this component's top-left into a screen coordinate. More...
|
|
Rectangle< int > | localAreaToGlobal (Rectangle< int > localArea) const |
| Converts a rectangle from this component's coordinate space to a screen coordinate. More...
|
|
Rectangle< float > | localAreaToGlobal (Rectangle< float > localArea) const |
| Converts a rectangle from this component's coordinate space to a screen coordinate. More...
|
|
void | setTopLeftPosition (int x, int y) |
| Moves the component to a new position. More...
|
|
void | setTopLeftPosition (Point< int > newTopLeftPosition) |
| Moves the component to a new position. More...
|
|
void | setTopRightPosition (int x, int y) |
| Moves the component to a new position. More...
|
|
void | setSize (int newWidth, int newHeight) |
| Changes the size of the component. More...
|
|
void | setBounds (int x, int y, int width, int height) |
| Changes the component's position and size. More...
|
|
void | setBounds (Rectangle< int > newBounds) |
| Changes the component's position and size. More...
|
|
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. More...
|
|
void | setBoundsRelative (Rectangle< float > proportionalArea) |
| Changes the component's position and size in terms of fractions of its parent's size. More...
|
|
void | setBoundsInset (BorderSize< int > borders) |
| Changes the component's position and size based on the amount of space to leave around it. More...
|
|
void | setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize) |
| Positions the component within a given rectangle, keeping its proportions unchanged. More...
|
|
void | setCentrePosition (int x, int y) |
| Changes the position of the component's centre. More...
|
|
void | setCentrePosition (Point< int > newCentrePosition) |
| Changes the position of the component's centre. More...
|
|
void | setCentreRelative (float x, float y) |
| Changes the position of the component's centre. More...
|
|
void | centreWithSize (int width, int height) |
| Changes the component's size and centres it within its parent. More...
|
|
void | setTransform (const AffineTransform &transform) |
| Sets a transform matrix to be applied to this component. More...
|
|
AffineTransform | getTransform () const |
| Returns the transform that is currently being applied to this component. More...
|
|
bool | isTransformed () const noexcept |
| Returns true if a non-identity transform is being applied to this component. More...
|
|
int | proportionOfWidth (float proportion) const noexcept |
| Returns a proportion of the component's width. More...
|
|
int | proportionOfHeight (float proportion) const noexcept |
| Returns a proportion of the component's height. More...
|
|
int | getParentWidth () const noexcept |
| Returns the width of the component's parent. More...
|
|
int | getParentHeight () const noexcept |
| Returns the height of the component's parent. More...
|
|
Rectangle< int > | getParentMonitorArea () const |
| Returns the screen coordinates of the monitor that contains this component. More...
|
|
int | getNumChildComponents () const noexcept |
| Returns the number of child components that this component contains. More...
|
|
Component * | getChildComponent (int index) const noexcept |
| Returns one of this component's child components, by it index. More...
|
|
int | getIndexOfChildComponent (const Component *child) const noexcept |
| Returns the index of this component in the list of child components. More...
|
|
const Array< Component * > & | getChildren () const noexcept |
| Provides access to the underlying array of child components. More...
|
|
Component * | findChildWithID (StringRef componentID) const noexcept |
| Looks for a child component with the specified ID. More...
|
|
void | addChildComponent (Component *child, int zOrder=-1) |
| Adds a child component to this one. More...
|
|
void | addChildComponent (Component &child, int zOrder=-1) |
| Adds a child component to this one. More...
|
|
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. More...
|
|
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. More...
|
|
void | addChildAndSetID (Component *child, const String &componentID) |
| Adds a child component to this one, makes it visible, and sets its component ID. More...
|
|
void | removeChildComponent (Component *childToRemove) |
| Removes one of this component's child-components. More...
|
|
Component * | removeChildComponent (int childIndexToRemove) |
| Removes one of this component's child-components by index. More...
|
|
void | removeAllChildren () |
| Removes all this component's children. More...
|
|
void | deleteAllChildren () |
| Removes and deletes all of this component's children. More...
|
|
Component * | getParentComponent () const noexcept |
| Returns the component which this component is inside. More...
|
|
template<class TargetClass > |
TargetClass * | findParentComponentOfClass () const |
| Searches the parent components for a component of a specified class. More...
|
|
Component * | getTopLevelComponent () const noexcept |
| Returns the highest-level component which contains this one or its parents. More...
|
|
bool | isParentOf (const Component *possibleChild) const noexcept |
| Checks whether a component is anywhere inside this component or its children. More...
|
|
virtual void | parentHierarchyChanged () |
| Called to indicate that the component's parents have changed. More...
|
|
virtual void | childrenChanged () |
| Subclasses can use this callback to be told when children are added or removed, or when their z-order changes. More...
|
|
virtual bool | hitTest (int x, int y) |
| Tests whether a given point is inside the component. More...
|
|
void | setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept |
| Changes the default return value for the hitTest() method. More...
|
|
void | getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept |
| Retrieves the current state of the mouse-click interception flags. More...
|
|
bool | contains (Point< int > localPoint) |
| Returns true if a given point lies within this component or one of its children. More...
|
|
bool | contains (Point< float > localPoint) |
| Returns true if a given point lies within this component or one of its children. More...
|
|
bool | reallyContains (Point< int > localPoint, bool returnTrueIfWithinAChild) |
| Returns true if a given point lies in this component, taking any overlapping siblings into account. More...
|
|
bool | reallyContains (Point< float > localPoint, bool returnTrueIfWithinAChild) |
| Returns true if a given point lies in this component, taking any overlapping siblings into account. More...
|
|
Component * | getComponentAt (int x, int y) |
| Returns the component at a certain point within this one. More...
|
|
Component * | getComponentAt (Point< int > position) |
| Returns the component at a certain point within this one. More...
|
|
Component * | getComponentAt (Point< float > position) |
| Returns the component at a certain point within this one. More...
|
|
void | repaint () |
| Marks the whole component as needing to be redrawn. More...
|
|
void | repaint (int x, int y, int width, int height) |
| Marks a subsection of this component as needing to be redrawn. More...
|
|
void | repaint (Rectangle< int > area) |
| Marks a subsection of this component as needing to be redrawn. More...
|
|
void | setBufferedToImage (bool shouldBeBuffered) |
| Makes the component use an internal buffer to optimise its redrawing. More...
|
|
Image | createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f) |
| Generates a snapshot of part of this component. More...
|
|
void | paintEntireComponent (Graphics &context, bool ignoreAlphaLevel) |
| Draws this component and all its subcomponents onto the specified graphics context. More...
|
|
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. More...
|
|
bool | isPaintingUnclipped () const noexcept |
| Returns true if this component doesn't require its graphics context to be clipped when it is being painted. More...
|
|
void | setComponentEffect (ImageEffectFilter *newEffect) |
| Adds an effect filter to alter the component's appearance. More...
|
|
ImageEffectFilter * | getComponentEffect () const noexcept |
| Returns the current component effect. More...
|
|
LookAndFeel & | getLookAndFeel () const noexcept |
| Finds the appropriate look-and-feel to use for this component. More...
|
|
void | setLookAndFeel (LookAndFeel *newLookAndFeel) |
| Sets the look and feel to use for this component. More...
|
|
virtual void | lookAndFeelChanged () |
| Called to let the component react to a change in the look-and-feel setting. More...
|
|
void | sendLookAndFeelChange () |
| Calls the lookAndFeelChanged() method in this component and all its children. More...
|
|
void | setOpaque (bool shouldBeOpaque) |
| Indicates whether any parts of the component might be transparent. More...
|
|
bool | isOpaque () const noexcept |
| Returns true if no parts of this component are transparent. More...
|
|
void | setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept |
| Indicates whether the component should be brought to the front when clicked. More...
|
|
bool | isBroughtToFrontOnMouseClick () const noexcept |
| Indicates whether the component should be brought to the front when clicked-on. More...
|
|
void | setExplicitFocusOrder (int newFocusOrderIndex) |
| Sets the focus order of this component. More...
|
|
int | getExplicitFocusOrder () const |
| Returns the focus order of this component, if one has been specified. More...
|
|
void | setFocusContainerType (FocusContainerType containerType) noexcept |
| Sets whether this component is a container for components that can have their focus traversed, and the type of focus traversal that it supports. More...
|
|
bool | isFocusContainer () const noexcept |
| Returns true if this component has been marked as a focus container. More...
|
|
bool | isKeyboardFocusContainer () const noexcept |
| Returns true if this component has been marked as a keyboard focus container. More...
|
|
Component * | findFocusContainer () const |
| Returns the focus container for this component. More...
|
|
Component * | findKeyboardFocusContainer () const |
| Returns the keyboard focus container for this component. More...
|
|
void | setWantsKeyboardFocus (bool wantsFocus) noexcept |
| Sets a flag to indicate whether this component wants keyboard focus or not. More...
|
|
bool | getWantsKeyboardFocus () const noexcept |
| Returns true if the component is interested in getting keyboard focus. More...
|
|
void | setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus) |
| Chooses whether a click on this component automatically grabs the focus. More...
|
|
bool | getMouseClickGrabsKeyboardFocus () const noexcept |
| Returns the last value set with setMouseClickGrabsKeyboardFocus(). More...
|
|
void | grabKeyboardFocus () |
| Tries to give keyboard focus to this component. More...
|
|
void | giveAwayKeyboardFocus () |
| If this component or any of its children currently have the keyboard focus, this will defocus it, send a focus change notification, and try to pass the focus to the next component. More...
|
|
bool | hasKeyboardFocus (bool trueIfChildIsFocused) const |
| Returns true if this component currently has the keyboard focus. More...
|
|
void | moveKeyboardFocusToSibling (bool moveToNext) |
| Tries to move the keyboard focus to one of this component's siblings. More...
|
|
virtual std::unique_ptr< ComponentTraverser > | createFocusTraverser () |
| Creates a ComponentTraverser object to determine the logic by which focus should be passed from this component. More...
|
|
virtual std::unique_ptr< ComponentTraverser > | createKeyboardFocusTraverser () |
| Creates a ComponentTraverser object to use to determine the logic by which keyboard focus should be passed from this component. More...
|
|
void | setHasFocusOutline (bool hasFocusOutline) noexcept |
| Use this to indicate that the component should have an outline drawn around it when it has keyboard focus. More...
|
|
bool | hasFocusOutline () const noexcept |
| Returns true if this component should have a focus outline. More...
|
|
bool | isEnabled () const noexcept |
| Returns true if the component (and all its parents) are enabled. More...
|
|
void | setEnabled (bool shouldBeEnabled) |
| Enables or disables this component. More...
|
|
virtual void | enablementChanged () |
| Callback to indicate that this component has been enabled or disabled. More...
|
|
float | getAlpha () const noexcept |
| Returns the component's current transparency level. More...
|
|
void | setAlpha (float newAlpha) |
| Changes the transparency of this component. More...
|
|
virtual void | alphaChanged () |
| Called when setAlpha() is used to change the alpha value of this component. More...
|
|
void | setMouseCursor (const MouseCursor &cursorType) |
| Changes the mouse cursor shape to use when the mouse is over this component. More...
|
|
virtual MouseCursor | getMouseCursor () |
| Returns the mouse cursor shape to use when the mouse is over this component. More...
|
|
void | updateMouseCursor () const |
| Forces the current mouse cursor to be updated. More...
|
|
virtual void | paint (Graphics &g) |
| Components can override this method to draw their content. More...
|
|
virtual void | paintOverChildren (Graphics &g) |
| Components can override this method to draw over the top of their children. More...
|
|
void | mouseMove (const MouseEvent &event) override |
| Called when the mouse moves inside a component. More...
|
|
void | mouseEnter (const MouseEvent &event) override |
| Called when the mouse first enters a component. More...
|
|
void | mouseExit (const MouseEvent &event) override |
| Called when the mouse moves out of a component. More...
|
|
void | mouseDown (const MouseEvent &event) override |
| Called when a mouse button is pressed. More...
|
|
void | mouseDrag (const MouseEvent &event) override |
| Called when the mouse is moved while a button is held down. More...
|
|
void | mouseUp (const MouseEvent &event) override |
| Called when a mouse button is released. More...
|
|
void | mouseDoubleClick (const MouseEvent &event) override |
| Called when a mouse button has been double-clicked on a component. More...
|
|
void | mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) override |
| Called when the mouse-wheel is moved. More...
|
|
void | mouseMagnify (const MouseEvent &event, float scaleFactor) override |
| Called when a pinch-to-zoom mouse-gesture is used. More...
|
|
void | setRepaintsOnMouseActivity (bool shouldRepaint) noexcept |
| Causes automatic repaints when the mouse enters or exits this component. More...
|
|
void | addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents) |
| Registers a listener to be told when mouse events occur in this component. More...
|
|
void | removeMouseListener (MouseListener *listenerToRemove) |
| Deregisters a mouse listener. More...
|
|
void | addKeyListener (KeyListener *newListener) |
| Adds a listener that wants to hear about keypresses that this component receives. More...
|
|
void | removeKeyListener (KeyListener *listenerToRemove) |
| Removes a previously-registered key listener. More...
|
|
virtual bool | keyPressed (const KeyPress &key) |
| Called when a key is pressed. More...
|
|
virtual bool | keyStateChanged (bool isKeyDown) |
| Called when a key is pressed or released. More...
|
|
virtual void | modifierKeysChanged (const ModifierKeys &modifiers) |
| Called when a modifier key is pressed or released. More...
|
|
virtual void | focusGained (FocusChangeType cause) |
| Called to indicate that this component has just acquired the keyboard focus. More...
|
|
virtual void | focusLost (FocusChangeType cause) |
| Called to indicate that this component has just lost the keyboard focus. More...
|
|
virtual void | focusOfChildComponentChanged (FocusChangeType cause) |
| Called to indicate a change in whether or not this component is the parent of the currently-focused component. More...
|
|
bool | isMouseOver (bool includeChildren=false) const |
| Returns true if the mouse is currently over this component. More...
|
|
bool | isMouseButtonDown (bool includeChildren=false) const |
| Returns true if the mouse button is currently held down in this component. More...
|
|
bool | isMouseOverOrDragging (bool includeChildren=false) const |
| True if the mouse is over this component, or if it's being dragged in this component. More...
|
|
Point< int > | getMouseXYRelative () const |
| Returns the mouse's current position, relative to this component. More...
|
|
virtual void | resized () |
| Called when this component's size has been changed. More...
|
|
virtual void | moved () |
| Called when this component's position has been changed. More...
|
|
virtual void | childBoundsChanged (Component *child) |
| Called when one of this component's children is moved or resized. More...
|
|
virtual void | parentSizeChanged () |
| Called when this component's immediate parent has been resized. More...
|
|
virtual void | broughtToFront () |
| Called when this component has been moved to the front of its siblings. More...
|
|
void | addComponentListener (ComponentListener *newListener) |
| Adds a listener to be told about changes to the component hierarchy or position. More...
|
|
void | removeComponentListener (ComponentListener *listenerToRemove) |
| Removes a component listener. More...
|
|
void | postCommandMessage (int commandId) |
| Dispatches a numbered message to this component. More...
|
|
virtual void | handleCommandMessage (int commandId) |
| Called to handle a command that was sent by postCommandMessage(). More...
|
|
int | runModalLoop () |
| Runs a component modally, waiting until the loop terminates. More...
|
|
void | enterModalState (bool takeKeyboardFocus=true, ModalComponentManager::Callback *callback=nullptr, bool deleteWhenDismissed=false) |
| Puts the component into a modal state. More...
|
|
void | exitModalState (int returnValue) |
| Ends a component's modal state. More...
|
|
bool | isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept |
| Returns true if this component is the modal one. More...
|
|
bool | isCurrentlyBlockedByAnotherModalComponent () const |
| Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More...
|
|
virtual bool | canModalEventBeSentToComponent (const Component *targetComponent) |
| When a component is modal, this callback allows it to choose which other components can still receive events. More...
|
|
virtual void | inputAttemptWhenModal () |
| Called when the user tries to click on a component that is blocked by another modal component. More...
|
|
NamedValueSet & | getProperties () noexcept |
| Returns the set of properties that belong to this component. More...
|
|
const NamedValueSet & | getProperties () const noexcept |
| Returns the set of properties that belong to this component. More...
|
|
Colour | findColour (int colourID, bool inheritFromParent=false) const |
| Looks for a colour that has been registered with the given colour ID number. More...
|
|
void | setColour (int colourID, Colour newColour) |
| Registers a colour to be used for a particular purpose. More...
|
|
void | removeColour (int colourID) |
| If a colour has been set with setColour(), this will remove it. More...
|
|
bool | isColourSpecified (int colourID) const |
| Returns true if the specified colour ID has been explicitly set for this component using the setColour() method. More...
|
|
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. More...
|
|
virtual void | colourChanged () |
| This method is called when a colour is changed by the setColour() method. More...
|
|
void * | getWindowHandle () const |
| Returns the underlying native window handle for this component. More...
|
|
Positioner * | getPositioner () const noexcept |
| Returns the Positioner object that has been set for this component. More...
|
|
void | setPositioner (Positioner *newPositioner) |
| Sets a new Positioner object for this component. More...
|
|
void | setCachedComponentImage (CachedComponentImage *newCachedImage) |
| Gives the component a CachedComponentImage that should be used to buffer its painting. More...
|
|
CachedComponentImage * | getCachedComponentImage () const noexcept |
| Returns the object that was set by setCachedComponentImage(). More...
|
|
void | setViewportIgnoreDragFlag (bool ignoreDrag) noexcept |
| Sets a flag to indicate whether mouse drag events on this Component should be ignored when it is inside a Viewport with drag-to-scroll functionality enabled. More...
|
|
bool | getViewportIgnoreDragFlag () const noexcept |
| Retrieves the current state of the Viewport drag-to-scroll functionality flag. More...
|
|
String | getTitle () const noexcept |
| Returns the title text for this component. More...
|
|
void | setTitle (const String &newTitle) |
| Sets the title for this component. More...
|
|
String | getDescription () const noexcept |
| Returns the description for this component. More...
|
|
void | setDescription (const String &newDescription) |
| Sets the description for this component. More...
|
|
String | getHelpText () const noexcept |
| Returns the help text for this component. More...
|
|
void | setHelpText (const String &newHelpText) |
| Sets the help text for this component. More...
|
|
void | setAccessible (bool shouldBeAccessible) |
| Sets whether this component and its children are visible to accessibility clients. More...
|
|
bool | isAccessible () const noexcept |
| Returns true if this component and its children are visible to accessibility clients. More...
|
|
AccessibilityHandler * | getAccessibilityHandler () |
| Returns the accessibility handler for this component, or nullptr if this component is not accessible. More...
|
|
void | invalidateAccessibilityHandler () |
| Invalidates the AccessibilityHandler that is currently being used for this component. More...
|
|
virtual | ~MouseListener ()=default |
| Destructor. More...
|
|
virtual void | mouseMove (const MouseEvent &event) |
| Called when the mouse moves inside a component. More...
|
|
virtual void | mouseEnter (const MouseEvent &event) |
| Called when the mouse first enters a component. More...
|
|
virtual void | mouseExit (const MouseEvent &event) |
| Called when the mouse moves out of a component. More...
|
|
virtual void | mouseDown (const MouseEvent &event) |
| Called when a mouse button is pressed. More...
|
|
virtual void | mouseDrag (const MouseEvent &event) |
| Called when the mouse is moved while a button is held down. More...
|
|
virtual void | mouseUp (const MouseEvent &event) |
| Called when a mouse button is released. More...
|
|
virtual void | mouseDoubleClick (const MouseEvent &event) |
| Called when a mouse button has been double-clicked on a component. More...
|
|
virtual void | mouseWheelMove (const MouseEvent &event, const MouseWheelDetails &wheel) |
| Called when the mouse-wheel is moved. More...
|
|
virtual void | mouseMagnify (const MouseEvent &event, float scaleFactor) |
| Called when a pinch-to-zoom mouse-gesture is used. More...
|
|
| TextInputTarget ()=default |
|
virtual | ~TextInputTarget ()=default |
| Destructor. More...
|
|
virtual bool | isTextInputActive () const =0 |
| Returns true if this input target is currently accepting input. More...
|
|
virtual Range< int > | getHighlightedRegion () const =0 |
| Returns the extents of the selected text region, or an empty range if nothing is selected,. More...
|
|
virtual void | setHighlightedRegion (const Range< int > &newRange)=0 |
| Sets the currently-selected text region. More...
|
|
virtual void | setTemporaryUnderlining (const Array< Range< int > > &underlinedRegions)=0 |
| Sets a number of temporarily underlined sections. More...
|
|
virtual String | getTextInRange (const Range< int > &range) const =0 |
| Returns a specified sub-section of the text. More...
|
|
virtual void | insertTextAtCaret (const String &textToInsert)=0 |
| Inserts some text, overwriting the selected text region, if there is one. More...
|
|
virtual Rectangle< int > | getCaretRectangle ()=0 |
| Returns the position of the caret, relative to the component's origin. More...
|
|
virtual VirtualKeyboardType | getKeyboardType () |
| Returns the target's preference for the type of keyboard that would be most appropriate. More...
|
|
| ~SettableTooltipClient () override=default |
| Destructor. More...
|
|
virtual void | setTooltip (const String &newTooltip) |
| Assigns a new tooltip to this object. More...
|
|
String | getTooltip () override |
| Returns the tooltip assigned to this object. More...
|
|
virtual | ~TooltipClient ()=default |
| Destructor. More...
|
|
virtual String | getTooltip ()=0 |
| Returns the string that this object wants to show as its tooltip. More...
|
|