 |
JUCE
v5.4.1-191-g0ab5e696f
JUCE API
|
|
|
JUCE
v5.4.1-191-g0ab5e696f
JUCE API
|
|
A table of cells, using a TableHeaderComponent as its header. More...
#include <juce_Doxygen_notes.h>
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1002800, outlineColourId = 0x1002810, textColourId = 0x1002820 } |
| A set of colour IDs to use to change the colour of various aspects of the label. More... | |
| enum | FocusChangeType { focusChangedByMouseClick, focusChangedByTabKey, focusChangedDirectly } |
| Enumeration used by the focusChanged() and focusLost() methods. More... | |
Public Member Functions | |
| TableListBox (const String &componentName=String(), TableListBoxModel *model=nullptr) | |
| Creates a TableListBox. More... | |
| ~TableListBox () override | |
| Destructor. 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 | 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 | addComponentListener (ComponentListener *newListener) |
| Adds a listener to be told about changes to the component hierarchy or position. More... | |
| void | addKeyListener (KeyListener *newListener) |
| Adds a listener that wants to hear about keypresses that this component receives. More... | |
| void | addMouseListener (MouseListener *newListener, bool wantsEventsForAllNestedChildComponents) |
| Registers a listener to be told when mouse events occur in this component. More... | |
| virtual void | addToDesktop (int windowStyleFlags, void *nativeWindowToAttachTo=nullptr) |
| Makes this component appear as a window on the desktop. More... | |
| virtual void | alphaChanged () |
| Called when setAlpha() is used to change the alpha value of this component. More... | |
| void | autoSizeAllColumns () |
| Calls autoSizeColumn() for all columns in the table. More... | |
| void | autoSizeColumn (int columnId) |
| Resizes a column to fit its contents. More... | |
| void | backgroundClicked (const MouseEvent &) override |
| virtual void | broughtToFront () |
| Called when this component has been moved to the front of its siblings. 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... | |
| void | centreWithSize (int width, int height) |
| Changes the component's size and centres it within its parent. More... | |
| virtual void | childBoundsChanged (Component *child) |
| Called when one of this component's children is moved or resized. 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... | |
| void | colourChanged () override |
| bool | contains (Point< int > localPoint) |
| Returns true if a given point lies within this component or one of its children. 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... | |
| Image | createComponentSnapshot (Rectangle< int > areaToGrab, bool clipImageToComponentBounds=true, float scaleFactor=1.0f) |
| Generates a snapshot of part of this component. More... | |
| virtual KeyboardFocusTraverser * | createFocusTraverser () |
| Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component. More... | |
| virtual Image | createSnapshotOfRows (const SparseSet< int > &rows, int &x, int &y) |
| This fairly obscure method creates an image that shows the row components specified in rows (for example, these could be the currently selected row components). More... | |
| void | deleteAllChildren () |
| Removes and deletes all of this component's children. More... | |
| void | deleteKeyPressed (int currentSelectedRow) override |
| void | deselectAllRows () |
| Deselects any currently selected rows. More... | |
| void | deselectRow (int rowNumber) |
| Deselects a row. More... | |
| virtual void | enablementChanged () |
| Callback to indicate that this component has been enabled or disabled. 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... | |
| Component * | findChildWithID (StringRef componentID) const noexcept |
| Looks for a child component with the specified ID. More... | |
| Colour | findColour (int colourID, bool inheritFromParent=false) const |
| Looks for a colour that has been registered with the given colour ID number. More... | |
| template<class TargetClass > | |
| TargetClass * | findParentComponentOfClass () const |
| Searches the parent components for a component of a specified class. More... | |
| void | flipRowSelection (int rowNumber) |
| Selects or deselects a row. 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... | |
| float | getAlpha () const noexcept |
| Returns the component's current transparancy level. 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 > | getBoundsInParent () const noexcept |
| Returns the area of this component's parent which this component covers. More... | |
| CachedComponentImage * | getCachedComponentImage () const noexcept |
| Returns the object that was set by setCachedComponentImage(). More... | |
| Component * | getCellComponent (int columnId, int rowNumber) const |
| Returns the component that currently represents a given cell. More... | |
| Rectangle< int > | getCellPosition (int columnId, int rowNumber, bool relativeToComponentTopLeft) const |
| Returns the position of one of the cells in the table. More... | |
| Component * | getChildComponent (int index) const noexcept |
| Returns one of this component's child components, by it index. More... | |
| const Array< Component * > & | getChildren () const noexcept |
| Provides access to the underlying array of child components. 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... | |
| ImageEffectFilter * | getComponentEffect () const noexcept |
| Returns the current component effect. More... | |
| Component * | getComponentForRowNumber (int rowNumber) const noexcept |
| Finds the row component for a given row in the list. More... | |
| const String & | getComponentID () const noexcept |
| Returns the ID string that was set by setComponentID(). More... | |
| virtual float | getDesktopScaleFactor () const |
| Returns the default scale factor to use for this component when it is placed on the desktop. More... | |
| int | getExplicitFocusOrder () const |
| Returns the focus order of this component, if one has been specified. More... | |
| TableHeaderComponent & | getHeader () const noexcept |
| Returns the header component being used in this table. More... | |
| Component * | getHeaderComponent () const noexcept |
| Returns whatever header component was set with setHeaderComponent(). More... | |
| int | getHeaderHeight () const noexcept |
| Returns the height of the table header. More... | |
| int | getHeight () const noexcept |
| Returns the component's height in pixels. More... | |
| ScrollBar & | getHorizontalScrollBar () const noexcept |
| Returns a reference to the horizontal scrollbar. More... | |
| int | getIndexOfChildComponent (const Component *child) const noexcept |
| Returns the index of this component in the list of child components. More... | |
| int | getInsertionIndexForPosition (int x, int y) const noexcept |
| Finds a row index that would be the most suitable place to insert a new item for a given position. More... | |
| void | getInterceptsMouseClicks (bool &allowsClicksOnThisComponent, bool &allowsClicksOnChildComponents) const noexcept |
| Retrieves the current state of the mouse-click interception flags. More... | |
| int | getLastRowSelected () const |
| Returns the last row that the user selected. 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< int > | getLocalBounds () const noexcept |
| Returns the component's bounds, relative to its own origin. 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... | |
| LookAndFeel & | getLookAndFeel () const noexcept |
| Finds the appropriate look-and-feel to use for this component. More... | |
| TableListBoxModel * | getModel () const noexcept |
| Returns the model currently in use. More... | |
| bool | getMouseClickGrabsKeyboardFocus () const noexcept |
| Returns the last value set with setMouseClickGrabsKeyboardFocus(). More... | |
| virtual MouseCursor | getMouseCursor () |
| Returns the mouse cursor shape to use when the mouse is over this component. More... | |
| Point< int > | getMouseXYRelative () const |
| Returns the mouse's current position, relative to this component. More... | |
| const String & | getName () const noexcept |
| Returns the name of this component. More... | |
| int | getNumChildComponents () const noexcept |
| Returns the number of child components that this component contains. More... | |
| int | getNumRows () override |
| int | getNumRowsOnScreen () const noexcept |
| Returns the number of rows actually visible. More... | |
| int | getNumSelectedRows () const |
| Returns the number of rows that are currently selected. More... | |
| int | getOutlineThickness () const noexcept |
| Returns the thickness of outline that will be drawn around the listbox. More... | |
| Component * | getParentComponent () const noexcept |
| Returns the component which this component is inside. 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 | getParentWidth () const noexcept |
| Returns the width of the component's parent. More... | |
| ComponentPeer * | getPeer () const |
| Returns the heavyweight window that contains this component. More... | |
| Point< int > | getPosition () const noexcept |
| Returns the component's top-left position as a Point. More... | |
| Positioner * | getPositioner () const noexcept |
| Returns the Positioner object that has been set for this 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... | |
| int | getRight () const noexcept |
| Returns the x coordinate of the component's right-hand edge. More... | |
| int | getRowContainingPosition (int x, int y) const noexcept |
| Finds the row index that contains a given x,y position. More... | |
| int | getRowHeight () const noexcept |
| Returns the height of a row in the list. More... | |
| int | getRowNumberOfComponent (Component *rowComponent) const noexcept |
| Returns the row number that the given component represents. More... | |
| Rectangle< int > | getRowPosition (int rowNumber, bool relativeToComponentTopLeft) const noexcept |
| Returns the position of one of the rows, relative to the top-left of the listbox. More... | |
| Rectangle< int > | getScreenBounds () const |
| Returns the bounds of this component, relative to the screen's top-left. More... | |
| Point< int > | getScreenPosition () const |
| Returns the position of this component's top-left corner relative to the screen's top-left. 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... | |
| int | getSelectedRow (int index=0) const |
| Returns the row number of a selected row. More... | |
| SparseSet< int > | getSelectedRows () const |
| Returns a sparse set indicating the rows that are currently selected. More... | |
| String | getTooltip () override |
| Returns the tooltip assigned to this object. More... | |
| Component * | getTopLevelComponent () const noexcept |
| Returns the highest-level component which contains this one or its parents. More... | |
| AffineTransform | getTransform () const |
| Returns the transform that is currently being applied to this component. More... | |
| double | getVerticalPosition () const |
| Returns the current vertical position as a proportion of the total. More... | |
| ScrollBar & | getVerticalScrollBar () const noexcept |
| Returns a reference to the vertical scrollbar. More... | |
| Viewport * | getViewport () const noexcept |
| Returns the viewport that this ListBox uses. More... | |
| bool | getViewportIgnoreDragFlag () const noexcept |
| Retrieves the current state of the Viewport drag-to-scroll functionality flag. More... | |
| int | getVisibleContentWidth () const noexcept |
| Returns the space currently available for the row items, taking into account borders, scrollbars, etc. More... | |
| int | getVisibleRowWidth () const noexcept |
| Returns the width of a row (which may be less than the width of this component if there's a scrollbar). More... | |
| bool | getWantsKeyboardFocus () const noexcept |
| Returns true if the component is interested in getting keyboard focus. More... | |
| int | getWidth () const noexcept |
| Returns the component's width in pixels. More... | |
| void * | getWindowHandle () const |
| Returns the underlying native window handle for this component. 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... | |
| void | grabKeyboardFocus () |
| Tries to give keyboard focus to this component. More... | |
| virtual void | handleCommandMessage (int commandId) |
| Called to handle a command that was sent by postCommandMessage(). More... | |
| bool | hasKeyboardFocus (bool trueIfChildIsFocused) const |
| Returns true if this component currently has the keyboard focus. More... | |
| virtual bool | hitTest (int x, int y) |
| Tests whether a given point is inside the component. More... | |
| virtual void | inputAttemptWhenModal () |
| Called when the user tries to click on a component that is blocked by another modal component. More... | |
| bool | isAlwaysOnTop () const noexcept |
| Returns true if this component is set to always stay in front of its siblings. More... | |
| bool | isAutoSizeMenuOptionShown () const noexcept |
| True if the auto-size options should be shown on the menu. More... | |
| bool | isBroughtToFrontOnMouseClick () const noexcept |
| Indicates whether the component should be brought to the front when clicked-on. 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... | |
| bool | isCurrentlyBlockedByAnotherModalComponent () const |
| Checks whether there's a modal component somewhere that's stopping this one from receiving messages. More... | |
| bool | isCurrentlyModal (bool onlyConsiderForemostModalComponent=true) const noexcept |
| Returns true if this component is the modal one. More... | |
| bool | isEnabled () const noexcept |
| Returns true if the component (and all its parents) are enabled. More... | |
| bool | isFocusContainer () const noexcept |
| Returns true if this component has been marked as a focus container. More... | |
| bool | isMouseButtonDown (bool includeChildren=false) const |
| Returns true if the mouse button is currently held down in this component. More... | |
| bool | isMouseOver (bool includeChildren=false) const |
| Returns true if the mouse is currently over 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... | |
| bool | isOnDesktop () const noexcept |
| Returns true if this component is currently showing on the desktop. More... | |
| bool | isOpaque () const noexcept |
| Returns true if no parts of this component are transparent. 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... | |
| bool | isParentOf (const Component *possibleChild) const noexcept |
| Checks whether a component is anywhere inside this component or its children. More... | |
| bool | isRowSelected (int rowNumber) const |
| Checks whether a row is selected. More... | |
| bool | isShowing () const |
| Tests whether this component and all its parents are visible. More... | |
| bool | isTransformed () const noexcept |
| Returns true if a non-identity transform is being applied to this component. More... | |
| bool | isVisible () const noexcept |
| Tests whether the component is visible or not. More... | |
| bool | keyPressed (const KeyPress &) override |
| bool | keyStateChanged (bool isKeyDown) override |
| void | listWasScrolled () override |
| Rectangle< int > | localAreaToGlobal (Rectangle< int > localArea) const |
| Converts a rectangle from this component's coordinate space to a screen coordinate. 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... | |
| virtual void | lookAndFeelChanged () |
| Called to let the component react to a change in the look-and-feel setting. More... | |
| virtual void | minimisationStateChanged (bool isNowMinimised) |
| Called for a desktop component which has just been minimised or un-minimised. More... | |
| virtual void | modifierKeysChanged (const ModifierKeys &modifiers) |
| Called when a modifier key is pressed or released. More... | |
| void | mouseDoubleClick (const MouseEvent &event) override |
| Called when a mouse button has been double-clicked on 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 | 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 | mouseMagnify (const MouseEvent &event, float scaleFactor) override |
| Called when a pinch-to-zoom mouse-gesture is used. More... | |
| void | mouseMove (const MouseEvent &event) override |
| Called when the mouse moves inside a component. More... | |
| void | mouseUp (const MouseEvent &) override |
| void | mouseWheelMove (const MouseEvent &, const MouseWheelDetails &) override |
| virtual void | moved () |
| Called when this component's position has been changed. More... | |
| void | moveKeyboardFocusToSibling (bool moveToNext) |
| Tries to move the keyboard focus to one of this component's siblings. More... | |
| void | paint (Graphics &) override |
| void | paintEntireComponent (Graphics &context, bool ignoreAlphaLevel) |
| Draws this component and all its subcomponents onto the specified graphics context. More... | |
| void | paintListBoxItem (int, Graphics &, int, int, bool) override |
| void | paintOverChildren (Graphics &) override |
| void | parentHierarchyChanged () override |
| virtual void | parentSizeChanged () |
| Called when this component's immediate parent has been resized. More... | |
| void | postCommandMessage (int commandId) |
| Dispatches a numbered message to this component. More... | |
| int | proportionOfHeight (float proportion) const noexcept |
| Returns a proportion of the component's height. More... | |
| int | proportionOfWidth (float proportion) const noexcept |
| Returns a proportion of the component's width. 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... | |
| Component * | refreshComponentForRow (int rowNumber, bool isRowSelected, Component *existingComponentToUpdate) override |
| void | removeAllChildren () |
| Removes all this component's children. 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 | removeColour (int colourID) |
| If a colour has been set with setColour(), this will remove it. More... | |
| void | removeComponentListener (ComponentListener *listenerToRemove) |
| Removes a component listener. More... | |
| void | removeFromDesktop () |
| If the component is currently showing on the desktop, this will hide it. More... | |
| void | removeKeyListener (KeyListener *listenerToRemove) |
| Removes a previously-registered key listener. More... | |
| void | removeMouseListener (MouseListener *listenerToRemove) |
| Deregisters a mouse listener. 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 | repaintRow (int rowNumber) noexcept |
| Repaints one of the rows. More... | |
| void | resized () override |
| void | returnKeyPressed (int currentSelectedRow) override |
| int | runModalLoop () |
| Runs a component modally, waiting until the loop terminates. More... | |
| void | scrollToEnsureColumnIsOnscreen (int columnId) |
| Scrolls horizontally if necessary to make sure that a particular column is visible. More... | |
| void | scrollToEnsureRowIsOnscreen (int row) |
| Scrolls if necessary to make sure that a particular row is visible. More... | |
| void | selectedRowsChanged (int row) override |
| void | selectRangeOfRows (int firstRow, int lastRow, bool dontScrollToShowThisRange=false) |
| Selects a set of rows. More... | |
| void | selectRow (int rowNumber, bool dontScrollToShowThisRow=false, bool deselectOthersFirst=true) |
| Selects a row. More... | |
| void | selectRowsBasedOnModifierKeys (int rowThatWasClickedOn, ModifierKeys modifiers, bool isMouseUpEvent) |
| Multiply-selects rows based on the modifier keys. More... | |
| void | sendLookAndFeelChange () |
| Calls the lookAndFeelChanged() method in this component and all its children. More... | |
| void | setAlpha (float newAlpha) |
| Changes the transparency of this component. More... | |
| void | setAlwaysOnTop (bool shouldStayOnTop) |
| Sets whether the component should always be kept at the front of its siblings. More... | |
| void | setAutoSizeMenuOptionShown (bool shouldBeShown) noexcept |
| Enables or disables the auto size options on the popup menu. 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 | setBoundsInset (BorderSize< int > borders) |
| Changes the component's position and size based on the amount of space to leave around it. 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 | setBoundsToFit (Rectangle< int > targetArea, Justification justification, bool onlyReduceInSize) |
| Positions the component within a given rectangle, keeping its proportions unchanged. More... | |
| void | setBroughtToFrontOnMouseClick (bool shouldBeBroughtToFront) noexcept |
| Indicates whether the component should be brought to the front when clicked. More... | |
| void | setBufferedToImage (bool shouldBeBuffered) |
| Makes the component use an internal buffer to optimise its redrawing. More... | |
| void | setCachedComponentImage (CachedComponentImage *newCachedImage) |
| Gives the component a CachedComponentImage that should be used to buffer its painting. 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 | setClickingTogglesRowSelection (bool flipRowSelection) noexcept |
| If enabled, this makes the listbox flip the selection status of each row that the user clicks, without affecting other selected rows. More... | |
| void | setColour (int colourID, Colour newColour) |
| Registers a colour to be used for a particular purpose. More... | |
| void | setComponentEffect (ImageEffectFilter *newEffect) |
| Adds an effect filter to alter the component's appearance. More... | |
| void | setComponentID (const String &newID) |
| Sets the component's ID string. More... | |
| void | setEnabled (bool shouldBeEnabled) |
| Enables or disables this component. More... | |
| void | setExplicitFocusOrder (int newFocusOrderIndex) |
| Sets the index used in determining the order in which focusable components should be traversed. More... | |
| void | setFocusContainer (bool shouldBeFocusContainer) noexcept |
| Indicates whether this component is a parent for components that can have their focus traversed. More... | |
| void | setHeader (TableHeaderComponent *newHeader) |
| Sets the header component to use for the table. More... | |
| void | setHeaderComponent (Component *newHeaderComponent) |
| Sets a component that the list should use as a header. More... | |
| void | setHeaderHeight (int newHeight) |
| Changes the height of the table header component. More... | |
| void | setInterceptsMouseClicks (bool allowClicksOnThisComponent, bool allowClicksOnChildComponents) noexcept |
| Changes the default return value for the hitTest() method. More... | |
| void | setLookAndFeel (LookAndFeel *newLookAndFeel) |
| Sets the look and feel to use for this component. More... | |
| void | setMinimumContentWidth (int newMinimumWidth) |
| Changes the width of the rows in the list. More... | |
| void | setModel (ListBoxModel *newModel) |
| Changes the current data model to display. More... | |
| void | setModel (TableListBoxModel *newModel) |
| Changes the TableListBoxModel that is being used for this table. More... | |
| void | setMouseClickGrabsKeyboardFocus (bool shouldGrabFocus) |
| Chooses whether a click on this component automatically grabs the focus. More... | |
| void | setMouseCursor (const MouseCursor &cursorType) |
| Changes the mouse cursor shape to use when the mouse is over this component. More... | |
| void | setMouseMoveSelectsRows (bool shouldSelect) |
| Makes the list react to mouse moves by selecting the row that the mouse if over. More... | |
| void | setMultipleSelectionEnabled (bool shouldBeEnabled) noexcept |
| Turns on multiple-selection of rows. More... | |
| virtual void | setName (const String &newName) |
| Sets the name of this component. More... | |
| void | setOpaque (bool shouldBeOpaque) |
| Indicates whether any parts of the component might be transparent. More... | |
| void | setOutlineThickness (int outlineThickness) |
| Sets the thickness of a border that will be drawn around the box. 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... | |
| void | setPositioner (Positioner *newPositioner) |
| Sets a new Positioner object for this component. More... | |
| void | setRepaintsOnMouseActivity (bool shouldRepaint) noexcept |
| Causes automatic repaints when the mouse enters or exits this component. More... | |
| void | setRowHeight (int newHeight) |
| Sets the height of each row in the list. More... | |
| void | setRowSelectedOnMouseDown (bool isSelectedOnMouseDown) noexcept |
| Sets whether a row should be selected when the mouse is pressed or released. More... | |
| void | setSelectedRows (const SparseSet< int > &setOfRowsToBeSelected, NotificationType sendNotificationEventToModel=sendNotification) |
| Sets the rows that should be selected, based on an explicit set of ranges. More... | |
| void | setSize (int newWidth, int newHeight) |
| Changes the size of the component. More... | |
| virtual void | setTooltip (const String &newTooltip) |
| Assigns a new tooltip to this object. 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 | setTransform (const AffineTransform &transform) |
| Sets a transform matrix to be applied to this component. More... | |
| void | setVerticalPosition (double newProportion) |
| Scrolls the list to a particular position. 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... | |
| virtual void | setVisible (bool shouldBeVisible) |
| Makes the component visible or invisible. More... | |
| void | setWantsKeyboardFocus (bool wantsFocus) noexcept |
| Sets a flag to indicate whether this component needs keyboard focus or not. More... | |
| void | startDragAndDrop (const MouseEvent &, const SparseSet< int > &rowsToDrag, const var &dragDescription, bool allowDraggingToOtherWindows) |
| void | tableColumnDraggingChanged (TableHeaderComponent *, int) override |
| void | tableColumnsChanged (TableHeaderComponent *) override |
| void | tableColumnsResized (TableHeaderComponent *) override |
| void | tableSortOrderChanged (TableHeaderComponent *) override |
| 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 | toFront (bool shouldAlsoGainFocus) |
| Brings the component to the front of its siblings. More... | |
| void | updateContent () |
| Causes the list to refresh its content. More... | |
| void | updateMouseCursor () const |
| Forces the current mouse cursor to be updated. More... | |
| virtual void | userTriedToCloseWindow () |
| For components on the desktop, this is called if the system wants to close the window. More... | |
| void | visibilityChanged () override |
Static Public Member Functions | |
| static void | beginDragAutoRepeat (int millisecondsBetweenCallbacks) |
| Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation. More... | |
| static Component * | getCurrentlyFocusedComponent () noexcept |
| Returns the component that currently has the keyboard focus. More... | |
| static Component * | getCurrentlyModalComponent (int index=0) noexcept |
| Returns one of the components that are currently modal. More... | |
| static int | getNumCurrentlyModalComponents () noexcept |
| Returns the number of components that are currently in a modal state. More... | |
| static bool | isMouseButtonDownAnywhere () noexcept |
| Returns true if a mouse button is currently down. More... | |
| static void | unfocusAllComponents () |
| If any component has keyboard focus, this will defocus it. More... | |
Private Member Functions | |
| virtual var | getDragSourceDescription (const SparseSet< int > &rowsToDescribe) |
| To allow rows from your list to be dragged-and-dropped, implement this method. More... | |
| virtual MouseCursor | getMouseCursorForRow (int row) |
| You can override this to return a custom mouse cursor for each row. More... | |
| virtual String | getTooltipForRow (int row) |
| You can override this to provide tool tips for specific rows. More... | |
| virtual void | listBoxItemClicked (int row, const MouseEvent &) |
| This can be overridden to react to the user clicking on a row. More... | |
| virtual void | listBoxItemDoubleClicked (int row, const MouseEvent &) |
| This can be overridden to react to the user double-clicking on a row. More... | |
| void | updateColumnComponents () const |
Private Attributes | |
| bool | autoSizeOptionsShown = true |
| int | columnIdNowBeingDragged = 0 |
| TableHeaderComponent * | header = nullptr |
| TableListBoxModel * | model |
A table of cells, using a TableHeaderComponent as its header.
This component makes it easy to create a table by providing a TableListBoxModel as the data source.
{GUI}
This example has a component that inherits from both juce::TableListBox and juce::TableListBoxModel, and makes the following calls to setup the table:
The following pure virtual methods from juce::TableListBoxModel are then defined to ensure the table cells are drawn correctly:
|
inherited |
A set of colour IDs to use to change the colour of various aspects of the label.
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.
|
inherited |
Enumeration used by the focusChanged() and focusLost() methods.
| Enumerator | |
|---|---|
| focusChangedByMouseClick | Means that the user clicked the mouse to change focus. |
| focusChangedByTabKey | Means that the user pressed the tab key to move the focus. |
| focusChangedDirectly | Means that the focus was changed by a call to grabKeyboardFocus(). |
| juce::TableListBox::TableListBox | ( | const String & | componentName = String(), |
| TableListBoxModel * | model = nullptr |
||
| ) |
Creates a TableListBox.
The model pointer passed-in can be null, in which case you can set it later with setModel(). The TableListBox does not take ownership of the model - it's the caller's responsibility to manage its lifetime and make sure it doesn't get deleted while still being used.
|
override |
Destructor.
Adds a child component to this one, and also makes the child visible if it isn't already.
This is the same as calling setVisible (true) on the child and then addChildComponent(). See addChildComponent() for more details.
| child | the new component to add. If the component passed-in is already the child of another component, it'll first be removed from it current parent. |
| zOrder | The index in the child-list at which this component should be inserted. A value of -1 will insert it in front of the others, 0 is the back. |
Referenced by juce::StandaloneFilterWindow::StandaloneFilterWindow().
Adds a child component to this one, and also makes the child visible if it isn't already.
This is the same as calling setVisible (true) on the child and then addChildComponent(). See addChildComponent() for more details.
| child | the new component to add. If the component passed-in is already the child of another component, it'll first be removed from it current parent. |
| zOrder | The index in the child-list at which this component should be inserted. A value of -1 will insert it in front of the others, 0 is the back. |
Adds a child component to this one, makes it visible, and sets its component ID.
Adds a child component to this one.
Adding a child component does not mean that the component will own or delete the child - it's your responsibility to delete the component. Note that it's safe to delete a component without first removing it from its parent - doing so will automatically remove it and send out the appropriate notifications before the deletion completes.
If the child is already a child of this component, then no action will be taken, and its z-order will be left unchanged.
| child | the new component to add. If the component passed-in is already the child of another component, it'll first be removed from it current parent. |
| zOrder | The index in the child-list at which this component should be inserted. A value of -1 will insert it in front of the others, 0 is the back. |
Adds a child component to this one.
Adding a child component does not mean that the component will own or delete the child - it's your responsibility to delete the component. Note that it's safe to delete a component without first removing it from its parent - doing so will automatically remove it and send out the appropriate notifications before the deletion completes.
If the child is already a child of this component, then no action will be taken, and its z-order will be left unchanged.
| child | the new component to add. If the component passed-in is already the child of another component, it'll first be removed from it current parent. |
| zOrder | The index in the child-list at which this component should be inserted. A value of -1 will insert it in front of the others, 0 is the back. |
|
inherited |
Adds a listener to be told about changes to the component hierarchy or position.
Component listeners get called when this component's size, position or children change - see the ComponentListener class for more details.
| newListener | the listener to register - if this is already registered, it will be ignored. |
|
inherited |
Adds a listener that wants to hear about keypresses that this component receives.
The listeners that are registered with a component are called by its keyPressed() or keyStateChanged() methods (assuming these haven't been overridden to do something else).
If you add an object as a key listener, be careful to remove it when the object is deleted, or the component will be left with a dangling pointer.
|
inherited |
Registers a listener to be told when mouse events occur in this component.
If you need to get informed about mouse events in a component but can't or don't want to override its methods, you can attach any number of listeners to the component, and these will get told about the events in addition to the component's own callbacks being called.
Note that a MouseListener can also be attached to more than one component.
| newListener | the listener to register |
| wantsEventsForAllNestedChildComponents | if true, the listener will receive callbacks for events that happen to any child component within this component, including deeply-nested child components. If false, it will only be told about events that this component handles. |
|
virtualinherited |
Makes this component appear as a window on the desktop.
Note that before calling this, you should make sure that the component's opacity is set correctly using setOpaque(). If the component is non-opaque, the windowing system will try to create a special transparent window for it, which will generally take a lot more CPU to operate (and might not even be possible on some platforms).
If the component is inside a parent component at the time this method is called, it will first be removed from that parent. Likewise if a component is on the desktop and is subsequently added to another component, it'll be removed from the desktop.
| windowStyleFlags | a combination of the flags specified in the ComponentPeer::StyleFlags enum, which define the window's characteristics. |
| nativeWindowToAttachTo | this allows an OS object to be passed-in as the window in which the juce component should place itself. On Windows, this would be a HWND, a HIViewRef on the Mac. Not necessarily supported on all platforms, and best left as 0 unless you know what you're doing. |
Reimplemented in juce::TopLevelWindow.
|
virtualinherited |
Called when setAlpha() is used to change the alpha value of this component.
If you override this, you should also invoke the base class's implementation during your overridden function, as it performs some repainting behaviour.
Reimplemented in juce::NSViewComponent.
| void juce::TableListBox::autoSizeAllColumns | ( | ) |
Calls autoSizeColumn() for all columns in the table.
| void juce::TableListBox::autoSizeColumn | ( | int | columnId | ) |
Resizes a column to fit its contents.
This uses TableListBoxModel::getColumnAutoSizeWidth() to find the best width, and applies that to the column.
|
overridevirtual |
Reimplemented from juce::ListBoxModel.
|
staticinherited |
Ensures that a non-stop stream of mouse-drag events will be sent during the current mouse-drag operation.
This allows you to make sure that mouseDrag() events are sent continuously, even when the mouse isn't moving. This can be useful for things like auto-scrolling components when the mouse is near an edge.
Call this method during a mouseDown() or mouseDrag() callback, specifying the minimum interval between consecutive mouse drag callbacks. The callbacks will continue until the mouse is released, and then the interval will be reset, so you need to make sure it's called every time you begin a drag event. Passing an interval of 0 or less will cancel the auto-repeat.
|
virtualinherited |
Called when this component has been moved to the front of its siblings.
The component may have been brought to the front by the toFront() method, or by the operating system if it's a top-level window.
Reimplemented in juce::XEmbedComponent, and juce::MultiDocumentPanelWindow.
|
virtualinherited |
When a component is modal, this callback allows it to choose which other components can still receive events.
When a modal component is active and the user clicks on a non-modal component, this method is called on the modal component, and if it returns true, the event is allowed to reach its target. If it returns false, the event is blocked and the inputAttemptWhenModal() callback is made.
It called by the isCurrentlyBlockedByAnotherModalComponent() method. The default implementation just returns false in all cases.
Changes the component's size and centres it within its parent.
After changing the size, the component will be moved so that it's centred within its parent. If the component is on the desktop (or has no parent component), then it'll be centred within the main monitor area.
|
virtualinherited |
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.
Reimplemented in juce::ResizableWindow, juce::CallOutBox, juce::TabBarButton, and juce::DrawableComposite.
|
virtualinherited |
Subclasses can use this callback to be told when children are added or removed, or when their z-order changes.
Reimplemented in juce::DrawableComposite.
|
overridevirtualinherited |
Reimplemented from juce::Component.
Returns true if a given point lies within this component or one of its children.
Never override this method! Use hitTest to create custom hit regions.
| localPoint | the coordinate to test, relative to this component's top-left. |
|
inherited |
This looks for any colours that have been specified for this component, and copies them to the specified target component.
|
inherited |
Generates a snapshot of part of this component.
This will return a new Image, the size of the rectangle specified, containing a snapshot of the specified area of the component and all its children.
The image may or may not have an alpha-channel, depending on whether the image is opaque or not.
If the clipImageToComponentBounds parameter is true and the area is greater than the size of the component, it'll be clipped. If clipImageToComponentBounds is false then parts of the component beyond its bounds can be drawn.
|
virtualinherited |
Creates a KeyboardFocusTraverser object to use to determine the logic by which focus should be passed from this component.
The default implementation of this method will return a default KeyboardFocusTraverser if this component is a focus container (as determined by the setFocusContainer() method). If the component isn't a focus container, then it will recursively ask its parents for a KeyboardFocusTraverser.
If you override this to return a custom KeyboardFocusTraverser, then this component and all its sub-components will use the new object to make their focusing decisions.
The method should return a new object, which the caller is required to delete when no longer needed.
Reimplemented in juce::Label, and juce::FilenameComponent.
|
virtualinherited |
This fairly obscure method creates an image that shows the row components specified in rows (for example, these could be the currently selected row components).
It's a handy method for doing drag-and-drop, as it can be passed to the DragAndDropContainer for use as the drag image.
Note that it will make the row components temporarily invisible, so if you're using custom components this could affect them if they're sensitive to that sort of thing.
|
inherited |
Removes and deletes all of this component's children.
My advice is to avoid this method! It's an old function that is only kept here for backwards-compatibility with legacy code, and should be viewed with extreme suspicion by anyone attempting to write modern C++. In almost all cases, it's much smarter to manage the lifetimes of your child components via modern RAII techniques such as simply making them member variables, or using std::unique_ptr, OwnedArray, etc to manage their lifetimes appropriately.
|
overridevirtual |
Reimplemented from juce::ListBoxModel.
|
inherited |
Deselects any currently selected rows.
|
inherited |
Deselects a row.
If it's not currently selected, this will do nothing.
|
virtualinherited |
Callback to indicate that this component has been enabled or disabled.
This can be triggered by one of the component's parent components being enabled or disabled, as well as changes to the component itself.
The default implementation of this method does nothing; your class may wish to repaint itself or something when this happens.
Reimplemented in juce::Slider, juce::TreeView, juce::TextEditor, juce::Button, juce::ComboBox, juce::Label, juce::DrawableButton, juce::PropertyComponent, juce::GroupComponent, and juce::ToolbarButton.
|
inherited |
Puts the component into a modal state.
This makes the component modal, so that messages are blocked from reaching any components other than this one and its children, but unlike runModalLoop(), this method returns immediately.
If takeKeyboardFocus is true, the component will use grabKeyboardFocus() to get the focus, which is usually what you'll want it to do. If not, it will leave the focus unchanged.
The callback is an optional object which will receive a callback when the modal component loses its modal status, either by being hidden or when exitModalState() is called. If you pass an object in here, the system will take care of deleting it later, after making the callback
If deleteWhenDismissed is true, then when it is dismissed, the component will be deleted and then the callback will be called. (This will safely handle the situation where the component is deleted before its exitModalState() method is called).
|
inherited |
Ends a component's modal state.
If this component is currently modal, this will turn off its modalness, and return a value to the runModalLoop() method that might have be running its modal loop.
Looks for a child component with the specified ID.
Looks for a colour that has been registered with the given colour ID number.
If a colour has been set for this ID number using setColour(), then it is returned. If none has been set, the method will try calling the component's LookAndFeel class's findColour() method. If none has been registered with the look-and-feel either, it will just return black.
The colour IDs for various purposes are stored as enums in the components that they are relevant to - for an example, see Slider::ColourIds, Label::ColourIds, TextEditor::ColourIds, TreeView::ColourIds, etc.
|
inlineinherited |
Searches the parent components for a component of a specified class.
For example findParentComponentOfClass <MyComp>() would return the first parent component that can be dynamically cast to a MyComp, or will return nullptr if none of the parents are suitable.
|
inherited |
Selects or deselects a row.
If the row's currently selected, this deselects it, and vice-versa.
|
virtualinherited |
Called to indicate that this component has just acquired the keyboard focus.
Reimplemented in juce::TextEditor, juce::Button, juce::ComboBox, juce::CodeEditorComponent, juce::Label, juce::WebBrowserComponent, and juce::XEmbedComponent.
|
virtualinherited |
Called to indicate that this component has just lost the keyboard focus.
Reimplemented in juce::TextEditor, juce::Button, juce::ComboBox, juce::CodeEditorComponent, juce::MidiKeyboardComponent, and juce::XEmbedComponent.
|
virtualinherited |
Called to indicate a change in whether or not this component is the parent of the currently-focused component.
Essentially this is called when the return value of a call to hasKeyboardFocus (true) has changed. It happens when focus moves from one of this component's children (at any depth) to a component that isn't contained in this one, (or vice-versa). Note that this method does NOT get called to when focus simply moves from one of its child components to another.
Reimplemented in juce::Slider, and juce::TopLevelWindow.
|
noexceptinherited |
Returns the component's current transparancy level.
See setAlpha() for more details.
|
inlinenoexceptinherited |
Returns the y coordinate of the bottom edge of this component.
This is a distance in pixels from the top edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to its bounding box.
Returns this component's bounding box.
The rectangle returned is relative to the top-left of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to its bounding box.
Returns the area of this component's parent which this component covers.
The returned area is relative to the parent's coordinate space. If the component has an affine transform specified, then the resulting area will be the smallest rectangle that fully covers the component's transformed bounding box. If this component has no parent, the return value will simply be the same as getBounds().
|
inlinenoexceptinherited |
Returns the object that was set by setCachedComponentImage().
Returns the component that currently represents a given cell.
If the component for this cell is off-screen or if the position is out-of-range, this may return nullptr.
| Rectangle<int> juce::TableListBox::getCellPosition | ( | int | columnId, |
| int | rowNumber, | ||
| bool | relativeToComponentTopLeft | ||
| ) | const |
Returns the position of one of the cells in the table.
If relativeToComponentTopLeft is true, the coordinates are relative to the table component's top-left. The row number isn't checked to see if it's in-range, but the column ID must exist or this will return an empty rectangle.
If relativeToComponentTopLeft is false, the coordinates are relative to the top-left of the table's top-left cell.
Returns one of this component's child components, by it index.
The component with index 0 is at the back of the z-order, the one at the front will have index (getNumChildComponents() - 1).
If the index is out-of-range, this will return a null pointer.
Provides access to the underlying array of child components.
The most likely reason you may want to use this is for iteration in a range-based for loop.
Returns the component at a certain point within this one.
| x | the x coordinate to test, relative to this component's left edge. |
| y | the y coordinate to test, relative to this component's top edge. |
Returns the component at a certain point within this one.
| position | the coordinate to test, relative to this component's top-left. |
|
inlinenoexceptinherited |
Finds the row component for a given row in the list.
The component returned will have been created using ListBoxModel::refreshComponentForRow().
If the component for this row is off-screen or if the row is out-of-range, this will return nullptr.
|
inlinenoexceptinherited |
Returns the ID string that was set by setComponentID().
|
staticnoexceptinherited |
Returns the component that currently has the keyboard focus.
|
staticnoexceptinherited |
Returns one of the components that are currently modal.
The index specifies which of the possible modal components to return. The order of the components in this list is the reverse of the order in which they became modal - so the component at index 0 is always the active component, and the others are progressively earlier ones that are themselves now blocked by later ones.
|
virtualinherited |
Returns the default scale factor to use for this component when it is placed on the desktop.
The default implementation of this method just returns the value from Desktop::getGlobalScaleFactor(), but it can be overridden if a particular component has different requirements. The method only used if this component is added to the desktop - it has no effect for child components.
Referenced by juce::CarbonViewWrapperComponent::setEmbeddedWindowToOurSize().
|
virtualinherited |
To allow rows from your list to be dragged-and-dropped, implement this method.
If this returns a non-null variant then when the user drags a row, the listbox will try to find a DragAndDropContainer in its parent hierarchy, and will use it to trigger a drag-and-drop operation, using this string as the source description, with the listbox itself as the source component.
|
inherited |
Returns the focus order of this component, if one has been specified.
By default components don't have a focus order - in that case, this will return 0. Lower numbers indicate that the component will be earlier in the focus traversal order.
To change the order, call setExplicitFocusOrder().
The focus order may be used by the KeyboardFocusTraverser class as part of its algorithm for deciding the order in which components should be traversed. See the KeyboardFocusTraverser class for more details on this.
|
inlinenoexcept |
Returns the header component being used in this table.
|
inlinenoexceptinherited |
Returns whatever header component was set with setHeaderComponent().
References JUCE_PUBLIC_IN_DLL_BUILD.
|
noexcept |
Returns the height of the table header.
|
inlinenoexceptinherited |
Returns the component's height in pixels.
Referenced by juce::CarbonViewWrapperComponent::createWindow(), juce::CarbonViewWrapperComponent::setEmbeddedWindowToOurSize(), and juce::CarbonViewWrapperComponent::setOurSizeToEmbeddedViewSize().
|
noexceptinherited |
Returns a reference to the horizontal scrollbar.
Returns the index of this component in the list of child components.
A value of 0 means it is first in the list (i.e. behind all other components). Higher values are further towards the front.
Returns -1 if the component passed-in is not a child of this component.
Finds a row index that would be the most suitable place to insert a new item for a given position.
This is useful when the user is e.g. dragging and dropping onto the listbox, because it lets you easily choose the best position to insert the item that they drop, based on where they drop it.
If the position is out of range, this will return -1. If the position is beyond the end of the list, it will return getNumRows() to indicate the end of the list.
|
noexceptinherited |
Retrieves the current state of the mouse-click interception flags.
On return, the two parameters are set to the state used in the last call to setInterceptsMouseClicks().
|
inherited |
Returns the last row that the user selected.
This isn't the same as the highest row number that is currently selected - if the user had multiply-selected rows 10, 5 and then 6 in that order, this would return 6.
If nothing is selected, it will return -1.
|
inherited |
Converts a rectangle to be relative to this component's coordinate space.
This takes a rectangle that is relative to a different component, and returns its position relative to this component. If the sourceComponent parameter is null, the source rectangle is assumed to be a screen coordinate.
If you've used setTransform() to apply one or more transforms to components, then the source rectangle may not actually be rectanglular when converted to the target space, so in that situation this will return the smallest rectangle that fully contains the transformed area.
Referenced by juce::OpenGLContext::NativeContext::NativeContext().
Returns the component's bounds, relative to its own origin.
This is like getBounds(), but returns the rectangle in local coordinates, In practice, it'll return a rectangle with position (0, 0), and the same size as this component.
Referenced by juce::OpenGLContext::NativeContext::NativeContext().
|
inherited |
Converts a point to be relative to this component's coordinate space.
This takes a point relative to a different component, and returns its position relative to this component. If the sourceComponent parameter is null, the source point is assumed to be a global screen coordinate.
|
inherited |
Converts a point to be relative to this component's coordinate space.
This takes a point relative to a different component, and returns its position relative to this component. If the sourceComponent parameter is null, the source point is assumed to be a global screen coordinate.
|
noexceptinherited |
Finds the appropriate look-and-feel to use for this component.
If the component hasn't had a look-and-feel explicitly set, this will return the parent's look-and-feel, or just the default one if there's no parent.
|
inlinenoexcept |
Returns the model currently in use.
|
noexceptinherited |
Returns the last value set with setMouseClickGrabsKeyboardFocus().
See setMouseClickGrabsKeyboardFocus() for more info.
|
virtualinherited |
Returns the mouse cursor shape to use when the mouse is over this component.
The default implementation will return the cursor that was set by setCursor() but can be overridden for more specialised purposes, e.g. returning different cursors depending on the mouse position.
Reimplemented in juce::TableHeaderComponent.
|
virtualinherited |
You can override this to return a custom mouse cursor for each row.
Returns the mouse's current position, relative to this component.
The return value is relative to the component's top-left corner.
|
inlinenoexceptinherited |
|
noexceptinherited |
Returns the number of child components that this component contains.
|
staticnoexceptinherited |
Returns the number of components that are currently in a modal state.
|
overridevirtual |
Implements juce::ListBoxModel.
|
noexceptinherited |
Returns the number of rows actually visible.
This is the number of whole rows which will fit on-screen, so the value might be more than the actual number of rows in the list.
|
inherited |
Returns the number of rows that are currently selected.
|
inlinenoexceptinherited |
Returns the thickness of outline that will be drawn around the listbox.
|
inlinenoexceptinherited |
Returns the component which this component is inside.
If this is the highest-level component or hasn't yet been added to a parent, this will return null.
Referenced by juce::CarbonViewWrapperComponent::setOurSizeToEmbeddedViewSize().
|
noexceptinherited |
Returns the height of the component's parent.
If the component has no parent (i.e. if it's on the desktop), this will return the height of the screen.
Returns the screen coordinates of the monitor that contains this component.
If there's only one monitor, this will return its size - if there are multiple monitors, it will return the area of the monitor that contains the component's centre.
|
noexceptinherited |
Returns the width of the component's parent.
If the component has no parent (i.e. if it's on the desktop), this will return the width of the screen.
|
inherited |
Returns the heavyweight window that contains this component.
If this component is itself on the desktop, this will return the window object that it is using. Otherwise, it will return the window of its top-level parent component.
This may return nullptr if there isn't a desktop component.
Referenced by juce::OpenGLContext::NativeContext::NativeContext(), juce::OpenGLContext::NativeContext::updateWindowPosition(), and juce::OpenGLContext::NativeContext::~NativeContext().
Returns the component's top-left position as a Point.
|
noexceptinherited |
Returns the Positioner object that has been set for this component.
|
inlinenoexceptinherited |
Returns the set of properties that belong to this component.
Each component has a NamedValueSet object which you can use to attach arbitrary items of data to it.
|
inlinenoexceptinherited |
Returns the set of properties that belong to this component.
Each component has a NamedValueSet object which you can use to attach arbitrary items of data to it.
|
inlinenoexceptinherited |
Returns the x coordinate of the component's right-hand edge.
This is a distance in pixels from the left edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to its bounding box.
Finds the row index that contains a given x,y position.
The position is relative to the ListBox's top-left. If no row exists at this position, the method will return -1.
|
inlinenoexceptinherited |
Returns the height of a row in the list.
Returns the row number that the given component represents.
If the component isn't one of the list's rows, this will return -1.
|
noexceptinherited |
Returns the position of one of the rows, relative to the top-left of the listbox.
This may be off-screen, and the range of the row number that is passed-in is not checked to see if it's a valid row.
Returns the bounds of this component, relative to the screen's top-left.
Referenced by juce::CarbonViewWrapperComponent::setEmbeddedWindowToOurSize().
Returns the position of this component's top-left corner relative to the screen's top-left.
|
inherited |
Returns this component's x coordinate relative the screen's top-left origin.
Referenced by juce::CarbonViewWrapperComponent::createWindow().
|
inherited |
Returns this component's y coordinate relative the screen's top-left origin.
Referenced by juce::CarbonViewWrapperComponent::createWindow().
Returns the row number of a selected row.
This will return the row number of the Nth selected row. The row numbers returned will be sorted in order from low to high.
| index | the index of the selected row to return, (from 0 to getNumSelectedRows() - 1) |
Returns a sparse set indicating the rows that are currently selected.
|
inlineoverridevirtualinherited |
Returns the tooltip assigned to this object.
Implements juce::TooltipClient.
Reimplemented in juce::ComboBox.
You can override this to provide tool tips for specific rows.
|
noexceptinherited |
Returns the highest-level component which contains this one or its parents.
This will search upwards in the parent-hierarchy from this component, until it finds the highest one that doesn't have a parent (i.e. is on the desktop or not yet added to a parent), and will return that.
Referenced by juce::CarbonViewWrapperComponent::carbonEventHandler(), juce::CarbonViewWrapperComponent::componentMovedOrResized(), juce::OpenGLContext::NativeContext::createNativeWindow(), juce::OpenGLContext::NativeContext::NativeContext(), and juce::CarbonViewWrapperComponent::setEmbeddedWindowToOurSize().
|
inherited |
Returns the transform that is currently being applied to this component.
For more details about transforms, see setTransform().
|
inherited |
Returns the current vertical position as a proportion of the total.
This can be used in conjunction with setVerticalPosition() to save and restore the list's position. It returns a value in the range 0 to 1.
|
noexceptinherited |
Returns a reference to the vertical scrollbar.
|
noexceptinherited |
Returns the viewport that this ListBox uses.
You may need to use this to change parameters such as whether scrollbars are shown, etc.
|
inlinenoexceptinherited |
Retrieves the current state of the Viewport drag-to-scroll functionality flag.
|
noexceptinherited |
Returns the space currently available for the row items, taking into account borders, scrollbars, etc.
|
noexceptinherited |
Returns the width of a row (which may be less than the width of this component if there's a scrollbar).
|
noexceptinherited |
Returns true if the component is interested in getting keyboard focus.
This returns the flag set by setWantsKeyboardFocus(). The default setting is false.
|
inlinenoexceptinherited |
Returns the component's width in pixels.
Referenced by juce::CarbonViewWrapperComponent::createWindow(), juce::CarbonViewWrapperComponent::setEmbeddedWindowToOurSize(), and juce::CarbonViewWrapperComponent::setOurSizeToEmbeddedViewSize().
|
inherited |
Returns the underlying native window handle for this component.
This is platform-dependent and strictly for power-users only!
Referenced by juce::CarbonViewWrapperComponent::getOwnerWindow().
|
inlinenoexceptinherited |
Returns the x coordinate of the component's left edge.
This is a distance in pixels from the left edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to its bounding box.
|
inlinenoexceptinherited |
Returns the y coordinate of the top of this component.
This is a distance in pixels from the top edge of the component's parent.
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to its bounding box.
|
inherited |
Tries to give keyboard focus to this component.
When the user clicks on a component or its grabKeyboardFocus() method is called, the following procedure is used to work out which component should get it:
Important note! It's obviously not possible for a component to be focused unless it's actually visible, on-screen, and inside a window that is also visible. So there's no point trying to call this in the component's own constructor or before all of its parent hierarchy has been fully instantiated.
|
virtualinherited |
Called to handle a command that was sent by postCommandMessage().
This is called by the message thread when a command message arrives, and the component can override this method to process it in any way it needs to.
Reimplemented in juce::TextEditor, juce::Button, juce::CallOutBox, juce::OpenGLContext::NativeContext::DummyComponent, juce::BurgerMenuComponent, juce::MenuBarComponent, and juce::OpenGLContext::NativeContext::DummyComponent.
Returns true if this component currently has the keyboard focus.
| trueIfChildIsFocused | if this is true, then the method returns true if either this component or any of its children (recursively) have the focus. If false, the method only returns true if this component has the focus. |
Tests whether a given point is inside the component.
Overriding this method allows you to create components which only intercept mouse-clicks within a user-defined area.
This is called to find out whether a particular x, y coordinate is considered to be inside the component or not, and is used by methods such as contains() and getComponentAt() to work out which component the mouse is clicked on.
Components with custom shapes will probably want to override it to perform some more complex hit-testing.
The default implementation of this method returns either true or false, depending on the value that was set by calling setInterceptsMouseClicks() (true is the default return value).
Note that the hit-test region is not related to the opacity with which areas of a component are painted.
Applications should never call hitTest() directly - instead use the contains() method, because this will also test for occlusion by the component's parent.
Note that for components on the desktop, this method will be ignored, because it's not always possible to implement this behaviour on all platforms.
| x | the x coordinate to test, relative to the left hand edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's width |
| y | the y coordinate to test, relative to the top edge of this component. This value is guaranteed to be greater than or equal to zero, and less than the component's height |
Reimplemented in juce::LassoComponent< SelectableItemType >, juce::ResizableBorderComponent, juce::CallOutBox, juce::ImageButton, juce::TabBarButton, juce::DrawableShape, juce::DrawableImage, juce::ResizableCornerComponent, and juce::JUCESplashScreen.
|
virtualinherited |
Called when the user tries to click on a component that is blocked by another modal component.
When a component is modal and the user clicks on one of the other components, the modal component will receive this callback.
The default implementation of this method will play a beep, and bring the currently modal component to the front, but it can be overridden to do other tasks.
Reimplemented in juce::Label, and juce::CallOutBox.
|
noexceptinherited |
Returns true if this component is set to always stay in front of its siblings.
|
inlinenoexcept |
True if the auto-size options should be shown on the menu.
|
noexceptinherited |
Indicates whether the component should be brought to the front when clicked-on.
Returns true if the specified colour ID has been explicitly set for this component using the setColour() method.
|
inherited |
Checks whether there's a modal component somewhere that's stopping this one from receiving messages.
If there is a modal component, its canModalEventBeSentToComponent() method will be called to see if it will still allow this component to receive events.
|
noexceptinherited |
Returns true if this component is the modal one.
It's possible to have nested modal components, e.g. a pop-up dialog box that launches another pop-up. If onlyConsiderForemostModalComponent is true then isCurrentlyModal will only return true for the one at the top of the stack. If onlyConsiderForemostModalComponent is false then isCurrentlyModal will return true for any modal component in the stack.
|
noexceptinherited |
Returns true if the component (and all its parents) are enabled.
Components are enabled by default, and can be disabled with setEnabled(). Exactly what difference this makes to the component depends on the type. E.g. buttons and sliders will choose to draw themselves differently, etc.
Note that if one of this component's parents is disabled, this will always return false, even if this component itself is enabled.
|
noexceptinherited |
Returns true if this component has been marked as a focus container.
See setFocusContainer() for more details.
Returns true if the mouse button is currently held down in this component.
Note that this is a test to see whether the mouse is being pressed in this component, so it'll return false if called on component A when the mouse is actually being dragged in component B.
|
staticnoexceptinherited |
Returns true if a mouse button is currently down.
Unlike isMouseButtonDown, this will test the current state of the buttons without regard to which component (if any) it has been pressed in.
Returns true if the mouse is currently over this component.
If the mouse isn't over the component, this will return false, even if the mouse is currently being dragged - so you can use this in your mouseDrag method to find out whether it's really over the component or not.
Note that when the mouse button is being held down, then the only component for which this method will return true is the one that was originally clicked on.
Also note that on a touch-screen device, this will only return true when a finger is actually down - as soon as all touch is released, isMouseOver will always return false.
If includeChildren is true, then this will also return true if the mouse is over any of the component's children (recursively) as well as the component itself.
True if the mouse is over this component, or if it's being dragged in this component.
This is a handy equivalent to (isMouseOver() || isMouseButtonDown()).
|
noexceptinherited |
Returns true if this component is currently showing on the desktop.
|
noexceptinherited |
Returns true if no parts of this component are transparent.
|
noexceptinherited |
Returns true if this component doesn't require its graphics context to be clipped when it is being painted.
Checks whether a component is anywhere inside this component or its children.
This will recursively check through this component's children to see if the given component is anywhere inside.
Checks whether a row is selected.
|
inherited |
Tests whether this component and all its parents are visible.
Referenced by juce::CarbonViewWrapperComponent::componentVisibilityChanged(), juce::SidePanel::isPanelShowing(), and juce::CarbonViewWrapperComponent::timerCallback().
|
noexceptinherited |
Returns true if a non-identity transform is being applied to this component.
For more details about transforms, see setTransform().
|
inlinenoexceptinherited |
Tests whether the component is visible or not.
this doesn't necessarily tell you whether this comp is actually on the screen because this depends on whether all the parent components are also visible - use isShowing() to find this out.
Reimplemented from juce::Component.
Reimplemented from juce::Component.
|
virtualinherited |
This can be overridden to react to the user clicking on a row.
Reimplemented in juce::BurgerMenuComponent.
|
virtualinherited |
This can be overridden to react to the user double-clicking on a row.
Reimplemented in juce::FileSearchPathListComponent.
|
overridevirtual |
Reimplemented from juce::ListBoxModel.
Converts a rectangle from this component's coordinate space to a screen coordinate.
If you've used setTransform() to apply one or more transforms to components, then the source rectangle may not actually be rectanglular when converted to the target space, so in that situation this will return the smallest rectangle that fully contains the transformed area.
Converts a point relative to this component's top-left into a screen coordinate.
Converts a point relative to this component's top-left into a screen coordinate.
|
virtualinherited |
Called to let the component react to a change in the look-and-feel setting.
When the look-and-feel is changed for a component, this will be called in all its child components, recursively.
It can also be triggered manually by the sendLookAndFeelChange() method, in case an application uses a LookAndFeel class that might have changed internally.
Reimplemented in juce::Slider, juce::TextEditor, juce::AlertWindow, juce::ComboBox, juce::ScrollBar, juce::ResizableWindow, juce::TabbedButtonBar, juce::Viewport, juce::FileBrowserComponent, juce::SidePanel, juce::FilenameComponent, juce::TabbedComponent, juce::ProgressBar, juce::MultiChoicePropertyComponent, and juce::OnlineUnlockForm.
|
virtualinherited |
Called for a desktop component which has just been minimised or un-minimised.
This will only be called for components on the desktop.
|
virtualinherited |
Called when a modifier key is pressed or released.
Whenever the shift, control, alt or command keys are pressed or released, this method will be called on the component that currently has the keyboard focus. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.
The default implementation of this method actually calls its parent's modifierKeysChanged method, so that focused components which aren't interested in this will give their parents a chance to act on the event instead.
Reimplemented in juce::Slider.
|
overridevirtualinherited |
Called when a mouse button has been double-clicked on a component.
The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.
| event | details about the position and status of the mouse event, including the source component in which it occurred |
Reimplemented from juce::MouseListener.
Reimplemented in juce::Slider, juce::TextEditor, juce::CodeEditorComponent, and juce::Label.
|
overridevirtualinherited |
Called when a mouse button is pressed.
The MouseEvent object passed in contains lots of methods for finding out which button was pressed, as well as which modifier keys (e.g. shift, ctrl) were held down at the time.
Once a button is held down, the mouseDrag method will be called when the mouse moves, until the button is released.
| event | details about the position and status of the mouse event, including the source component in which it occurred |
Reimplemented from juce::MouseListener.
Reimplemented in juce::Slider, juce::TextEditor, juce::AlertWindow, juce::TableHeaderComponent, juce::ScrollBar, juce::ComboBox, juce::ResizableWindow, juce::CodeEditorComponent, juce::Toolbar, juce::ResizableBorderComponent, juce::StretchableLayoutResizerBar, juce::ResizableEdgeComponent, juce::MenuBarComponent, and juce::ResizableCornerComponent.
|
overridevirtualinherited |
Called when the mouse is moved while a button is held down.
When a mouse button is pressed inside a component, that component receives mouseDrag callbacks each time the mouse moves, even if the mouse strays outside the component's bounds.
| event | details about the position and status of the mouse event, including the source component in which it occurred |
Reimplemented from juce::MouseListener.
Reimplemented in juce::Slider, juce::TextEditor, juce::AlertWindow, juce::TableHeaderComponent, juce::ScrollBar, juce::ComboBox, juce::ResizableWindow, juce::CodeEditorComponent, juce::ResizableBorderComponent, juce::SidePanel, juce::StretchableLayoutResizerBar, juce::ResizableEdgeComponent, juce::MenuBarComponent, and juce::ResizableCornerComponent.
|
overridevirtualinherited |
Called when the mouse first enters a component.
If the mouse button isn't pressed and the mouse moves into a component, this will be called to let the component react to this.
When the mouse button is pressed and held down while being moved in or out of a component, no mouseEnter or mouseExit callbacks are made - only mouseDrag messages are sent to the component that the mouse was originally clicked on, until the button is released.
| event | details about the position and status of the mouse event, including the source component in which it occurred |
Reimplemented from juce::MouseListener.
Reimplemented in juce::Slider, juce::TableHeaderComponent, juce::ResizableBorderComponent, juce::TooltipWindow, and juce::MenuBarComponent.
|
overridevirtualinherited |
Called when the mouse moves out of a component.
This will be called when the mouse moves off the edge of this component.
If the mouse button was pressed, and it was then dragged off the edge of the component and released, then this callback will happen when the button is released, after the mouseUp callback.
| event | details about the position and status of the mouse event, including the source component in which it occurred |
Reimplemented from juce::MouseListener.
Reimplemented in juce::Slider, juce::TableHeaderComponent, and juce::MenuBarComponent.
|
overridevirtualinherited |
Called when a pinch-to-zoom mouse-gesture is used.
If not overridden, a component will forward this message to its parent, so that parent components can collect gesture messages that are unused by child components.
| event | details about the mouse event |
| scaleFactor | a multiplier to indicate by how much the size of the target should be changed. A value of 1.0 would indicate no change, values greater than 1.0 mean it should be enlarged. |
Reimplemented from juce::MouseListener.
|
overridevirtualinherited |
Called when the mouse moves inside a component.
If the mouse button isn't pressed and the mouse moves over a component, this will be called to let the component react to this.
A component will always get a mouseEnter callback before a mouseMove.
| event | details about the position and status of the mouse event, including the source component in which it occurred |
Reimplemented from juce::MouseListener.
Reimplemented in juce::Slider, juce::TableHeaderComponent, juce::ResizableBorderComponent, and juce::MenuBarComponent.
|
overridevirtualinherited |
Reimplemented from juce::Component.
|
overridevirtualinherited |
Reimplemented from juce::Component.
|
virtualinherited |
Called when this component's position has been changed.
This is called when the position relative to its parent changes, not when its absolute position on the screen changes (so it won't be called for all child components when a parent component is moved).
The method is called synchronously as a result of the setBounds, setTopLeftPosition or any of the other repositioning methods, and like resized(), it will be called each time those methods are called.
If the component is a top-level window on the desktop, its position could also be changed by operating-system factors beyond the application's control.
Reimplemented in juce::ResizableWindow, juce::CallOutBox, and juce::SidePanel.
|
inherited |
Tries to move the keyboard focus to one of this component's siblings.
This will try to move focus to either the next or previous component. (This is the method that is used when shifting focus by pressing the tab key).
Components for which getWantsKeyboardFocus() returns false are not looked at.
| moveToNext | if true, the focus will move forwards; if false, it will move backwards |
|
overridevirtualinherited |
Reimplemented from juce::Component.
Draws this component and all its subcomponents onto the specified graphics context.
You should very rarely have to use this method, it's simply there in case you need to draw a component with a custom graphics context for some reason, e.g. for creating a snapshot of the component.
It calls paint(), paintOverChildren() and recursively calls paintEntireComponent() on its children in order to render the entire tree.
The graphics context may be left in an undefined state after this method returns, so you may need to reset it if you're going to use it again.
If ignoreAlphaLevel is false, then the component will be drawn with the opacity level specified by getAlpha(); if ignoreAlphaLevel is true, then this will be ignored and an alpha of 1.0 will be used.
Implements juce::ListBoxModel.
|
overridevirtualinherited |
Reimplemented from juce::Component.
|
overridevirtualinherited |
Reimplemented from juce::Component.
|
virtualinherited |
Called when this component's immediate parent has been resized.
If the component is a top-level window, this indicates that the screen size has changed.
Reimplemented in juce::ResizableWindow, and juce::JUCESplashScreen.
|
inherited |
Dispatches a numbered message to this component.
This is a quick and cheap way of allowing simple asynchronous messages to be sent to components. It's also safe, because if the component that you send the message to is a null or dangling pointer, this won't cause an error.
The command ID is later delivered to the component's handleCommandMessage() method by the application's message queue.
Returns a proportion of the component's height.
This is a handy equivalent of (getHeight() * proportion).
Returns a proportion of the component's width.
This is a handy equivalent of (getWidth() * proportion).
|
inherited |
Returns true if a given point lies in this component, taking any overlapping siblings into account.
| localPoint | the coordinate to test, relative to this component's top-left. |
| returnTrueIfWithinAChild | if the point actually lies within a child of this component, this determines whether that is counted as a hit. |
|
overridevirtual |
Reimplemented from juce::ListBoxModel.
|
inherited |
Removes all this component's children.
Note that this won't delete them! To do that, use deleteAllChildren() instead.
|
inherited |
Removes one of this component's child-components.
If the child passed-in isn't actually a child of this component (either because it's invalid or is the child of a different parent), then no action is taken.
Note that removing a child will not delete it! But it's ok to delete a component without first removing it - doing so will automatically remove it and send out the appropriate notifications before the deletion completes.
Removes one of this component's child-components by index.
This will return a pointer to the component that was removed, or null if the index was out-of-range.
Note that removing a child will not delete it! But it's ok to delete a component without first removing it - doing so will automatically remove it and send out the appropriate notifications before the deletion completes.
|
inherited |
If a colour has been set with setColour(), this will remove it.
This allows you to make a colour revert to its default state.
|
inherited |
Removes a component listener.
|
inherited |
If the component is currently showing on the desktop, this will hide it.
You can also use setVisible() to hide a desktop window temporarily, but removeFromDesktop() will free any system resources that are being used up.
|
inherited |
Removes a previously-registered key listener.
|
inherited |
Deregisters a mouse listener.
|
inherited |
Marks the whole component as needing to be redrawn.
Calling this will not do any repainting immediately, but will mark the component as 'dirty'. At some point in the near future the operating system will send a paint message, which will redraw all the dirty regions of all components. There's no guarantee about how soon after calling repaint() the redraw will actually happen, and other queued events may be delivered before a redraw is done.
If the setBufferedToImage() method has been used to cause this component to use a buffer, the repaint() call will invalidate the cached buffer. If setCachedComponentImage() has been used to provide a custom image cache, that cache will be invalidated appropriately.
To redraw just a subsection of the component rather than the whole thing, use the repaint (int, int, int, int) method.
Referenced by juce::OpenGLContext::NativeContext::NativeContext().
Marks a subsection of this component as needing to be redrawn.
Calling this will not do any repainting immediately, but will mark the given region of the component as 'dirty'. At some point in the near future the operating system will send a paint message, which will redraw all the dirty regions of all components. There's no guarantee about how soon after calling repaint() the redraw will actually happen, and other queued events may be delivered before a redraw is done.
The region that is passed in will be clipped to keep it within the bounds of this component.
Marks a subsection of this component as needing to be redrawn.
Calling this will not do any repainting immediately, but will mark the given region of the component as 'dirty'. At some point in the near future the operating system will send a paint message, which will redraw all the dirty regions of all components. There's no guarantee about how soon after calling repaint() the redraw will actually happen, and other queued events may be delivered before a redraw is done.
The region that is passed in will be clipped to keep it within the bounds of this component.
|
noexceptinherited |
Repaints one of the rows.
This does not invoke updateContent(), it just invokes a straightforward repaint for the area covered by this row.
|
overridevirtual |
Reimplemented from juce::ListBox.
|
overridevirtual |
Reimplemented from juce::ListBoxModel.
|
inherited |
Runs a component modally, waiting until the loop terminates.
This method first makes the component visible, brings it to the front and gives it the keyboard focus.
It then runs a loop, dispatching messages from the system message queue, but blocking all mouse or keyboard messages from reaching any components other than this one and its children.
This loop continues until the component's exitModalState() method is called (or the component is deleted), and then this method returns, returning the value passed into exitModalState().
Note that you SHOULD NEVER USE THIS METHOD! Modal loops are a dangerous construct because things that happen during the events that they dispatch could affect the state of objects which are currently in use somewhere on the stack, so when the loop finishes and the stack unwinds, horrible problems can occur. This is especially bad in plugins, where the host may choose to delete the plugin during runModalLoop(), so that when it returns, the entire DLL could have been unloaded from memory! Also, some OSes deliberately make it impossible to run modal loops (e.g. Android), so this method won't even exist on some platforms.
| void juce::TableListBox::scrollToEnsureColumnIsOnscreen | ( | int | columnId | ) |
Scrolls horizontally if necessary to make sure that a particular column is visible.
|
inherited |
Scrolls if necessary to make sure that a particular row is visible.
|
overridevirtual |
Reimplemented from juce::ListBoxModel.
|
inherited |
Selects a set of rows.
This will add these rows to the current selection, so you might need to clear the current selection first with deselectAllRows()
| firstRow | the first row to select (inclusive) |
| lastRow | the last row to select (inclusive) |
| dontScrollToShowThisRange | if true, the list's position won't change; if false and the selected range is off-screen, it'll scroll to make sure that the range of rows is on-screen |
|
inherited |
Selects a row.
If the row is already selected, this won't do anything.
| rowNumber | the row to select |
| dontScrollToShowThisRow | if true, the list's position won't change; if false and the selected row is off-screen, it'll scroll to make sure that row is on-screen |
| deselectOthersFirst | if true and there are multiple selections, these will first be deselected before this item is selected |
|
inherited |
Multiply-selects rows based on the modifier keys.
If no modifier keys are down, this will select the given row and deselect any others.
If the ctrl (or command on the Mac) key is down, it'll flip the state of the selected row.
If the shift key is down, it'll select up to the given row from the last row selected.
|
inherited |
Calls the lookAndFeelChanged() method in this component and all its children.
This will recurse through the children and their children, calling lookAndFeelChanged() on them all.
|
inherited |
Changes the transparency of this component.
When painted, the entire component and all its children will be rendered with this as the overall opacity level, where 0 is completely invisible, and 1.0 is fully opaque (i.e. normal).
|
inherited |
Sets whether the component should always be kept at the front of its siblings.
|
noexcept |
Enables or disables the auto size options on the popup menu.
By default, these are enabled.
Changes the component's position and size.
The coordinates are relative to the top-left of the component's parent, or relative to the origin of the screen if the component is on the desktop.
If this method changes the component's top-left position, it will make a synchronous call to moved(). If it changes the size, it will also make a call to resized().
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to whatever bounds you set for it.
Changes the component's position and size.
The coordinates are relative to the top-left of the component's parent, or relative to the origin of the screen if the component is on the desktop.
If this method changes the component's top-left position, it will make a synchronous call to moved(). If it changes the size, it will also make a call to resized().
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to whatever bounds you set for it.
|
inherited |
Changes the component's position and size based on the amount of space to leave around it.
This will position the component within its parent, leaving the specified number of pixels around each edge.
|
inherited |
Changes the component's position and size in terms of fractions of its parent's size.
The values are factors of the parent's size, so for example setBoundsRelative (0.2f, 0.2f, 0.5f, 0.5f) would give it half the width and height of the parent, with its top-left position 20% of the way across and down the parent.
Changes the component's position and size in terms of fractions of its parent's size.
The values are factors of the parent's size, so for example setBoundsRelative ({ 0.2f, 0.2f, 0.5f, 0.5f }) would give it half the width and height of the parent, with its top-left position 20% of the way across and down the parent.
|
inherited |
Positions the component within a given rectangle, keeping its proportions unchanged.
If onlyReduceInSize is false, the component will be resized to fill as much of the rectangle as possible without changing its aspect ratio (the component's current size is used to determine its aspect ratio, so a zero-size component won't work here). If onlyReduceInSize is true, it will only be resized if it's too big to fit inside the rectangle.
It will then be positioned within the rectangle according to the justification flags specified.
|
noexceptinherited |
Indicates whether the component should be brought to the front when clicked.
Setting this flag to true will cause the component to be brought to the front when the mouse is clicked somewhere inside it or its child components.
Note that a top-level desktop window might still be brought to the front by the operating system when it's clicked, depending on how the OS works.
By default this is set to false.
|
inherited |
Makes the component use an internal buffer to optimise its redrawing.
Setting this flag to true will cause the component to allocate an internal buffer into which it paints itself and all its child components, so that when asked to redraw itself, it can use this buffer rather than actually calling the paint() method.
Parts of the buffer are invalidated when repaint() is called on this component or its children. The buffer is then repainted at the next paint() callback.
|
inherited |
Gives the component a CachedComponentImage that should be used to buffer its painting.
The object that is passed-in will be owned by this component, and will be deleted automatically later on.
Changes the position of the component's centre.
Leaves the component's size unchanged, but sets the position of its centre relative to its parent's top-left.
Changes the position of the component's centre.
Leaves the component's size unchanged, but sets the position of its centre relative to its parent's top-left.
Changes the position of the component's centre.
Leaves the size unchanged, but positions its centre relative to its parent's size. E.g. setCentreRelative (0.5f, 0.5f) would place it centrally in its parent.
|
noexceptinherited |
If enabled, this makes the listbox flip the selection status of each row that the user clicks, without affecting other selected rows.
(This only has an effect if multiple selection is also enabled). If not enabled, you can still get the same row-flipping behaviour by holding down CMD or CTRL when clicking.
Registers a colour to be used for a particular purpose.
Changing a colour will cause a synchronous callback to the colourChanged() method, which your component can override if it needs to do something when colours are altered.
For more details about colour IDs, see the comments for findColour().
|
inherited |
Adds an effect filter to alter the component's appearance.
When a component has an effect filter set, then this is applied to the results of its paint() method. There are a few preset effects, such as a drop-shadow or glow, but they can be user-defined as well.
The effect that is passed in will not be deleted by the component - the caller must take care of deleting it.
To remove an effect from a component, pass a null pointer in as the parameter.
|
inherited |
Sets the component's ID string.
You can retrieve the ID using getComponentID().
|
inherited |
Enables or disables this component.
Disabling a component will also cause all of its child components to become disabled.
Similarly, enabling a component which is inside a disabled parent component won't make any difference until the parent is re-enabled.
|
inherited |
Sets the index used in determining the order in which focusable components should be traversed.
A value of 0 or less is taken to mean that no explicit order is wanted, and that traversal should use other factors, like the component's position.
|
noexceptinherited |
Indicates whether this component is a parent for components that can have their focus traversed.
This flag is used by the default implementation of the createFocusTraverser() method, which uses the flag to find the first parent component (of the currently focused one) which wants to be a focus container.
So using this method to set the flag to 'true' causes this component to act as the top level within which focus is passed around.
| void juce::TableListBox::setHeader | ( | TableHeaderComponent * | newHeader | ) |
Sets the header component to use for the table.
The table will take ownership of the component that you pass in, and will delete it when it's no longer needed. The pointer passed in may not be null.
|
inherited |
Sets a component that the list should use as a header.
This will position the given component at the top of the list, maintaining the height of the component passed-in, but rescaling it horizontally to match the width of the items in the listbox.
The component will be deleted when setHeaderComponent() is called with a different component, or when the listbox is deleted.
| void juce::TableListBox::setHeaderHeight | ( | int | newHeight | ) |
Changes the height of the table header component.
|
noexceptinherited |
Changes the default return value for the hitTest() method.
Setting this to false is an easy way to make a component pass its mouse-clicks through to the components behind it.
When a component is created, the default setting for this is true.
| allowClicksOnThisComponent | if true, hitTest() will always return true; if false, it will return false (or true for child components if allowClicksOnChildComponents is true) |
| allowClicksOnChildComponents | if this is true and allowClicksOnThisComponent is false, then child components can be clicked on as normal but clicks on this component pass straight through; if this is false and allowClicksOnThisComponent is false, then neither this component nor any child components can be clicked on |
|
inherited |
Sets the look and feel to use for this component.
This will also change the look and feel for any child components that haven't had their look set explicitly.
The object passed in will not be deleted by the component, so it's the caller's responsibility to manage it. It may be used at any time until this component has been deleted.
Calling this method will also invoke the sendLookAndFeelChange() method.
|
inherited |
Changes the width of the rows in the list.
This can be used to make the list's row components wider than the list itself - the width of the rows will be either the width of the list or this value, whichever is greater, and if the rows become wider than the list, a horizontal scrollbar will appear.
The default value for this is 0, which means that the rows will always be the same width as the list.
|
inherited |
Changes the current data model to display.
| void juce::TableListBox::setModel | ( | TableListBoxModel * | newModel | ) |
Changes the TableListBoxModel that is being used for this table.
The TableListBox does not take ownership of the model - it's the caller's responsibility to manage its lifetime and make sure it doesn't get deleted while still being used.
|
inherited |
Chooses whether a click on this component automatically grabs the focus.
By default this is set to true, but you might want a component which can be focused, but where you don't want the user to be able to affect it directly by clicking.
|
inherited |
Changes the mouse cursor shape to use when the mouse is over this component.
Note that the cursor set by this method can be overridden by the getMouseCursor method.
|
inherited |
Makes the list react to mouse moves by selecting the row that the mouse if over.
This function is here primarily for the ComboBox class to use, but might be useful for some other purpose too.
|
noexceptinherited |
Turns on multiple-selection of rows.
By default this is disabled.
When your row component gets clicked you'll need to call the selectRowsBasedOnModifierKeys() method to tell the list that it's been clicked and to get it to do the appropriate selection based on whether the ctrl/shift keys are held down.
|
virtualinherited |
Sets the name of this component.
When the name changes, all registered ComponentListeners will receive a ComponentListener::componentNameChanged() callback.
Reimplemented in juce::DocumentWindow.
|
inherited |
Indicates whether any parts of the component might be transparent.
Components that always paint all of their contents with solid colour and thus completely cover any components behind them should use this method to tell the repaint system that they are opaque.
This information is used to optimise drawing, because it means that objects underneath opaque windows don't need to be painted.
By default, components are considered transparent, unless this is used to make it otherwise.
|
inherited |
Sets the thickness of a border that will be drawn around the box.
To set the colour of the outline, use
|
noexceptinherited |
This allows you to indicate that this component doesn't require its graphics context to be clipped when it is being painted.
Most people will never need to use this setting, but in situations where you have a very large number of simple components being rendered, and where they are guaranteed never to do any drawing beyond their own boundaries, setting this to true will reduce the overhead involved in clipping the graphics context that gets passed to the component's paint() callback. If you enable this mode, you'll need to make sure your paint method doesn't call anything like Graphics::fillAll(), and doesn't draw beyond the component's bounds, because that'll produce artifacts. Your component also can't have any child components that may be placed beyond its bounds.
|
inherited |
Sets a new Positioner object for this component.
If there's currently another positioner set, it will be deleted. The object that is passed in will be deleted automatically by this component when it's no longer required. Pass a null pointer to clear the current positioner.
|
noexceptinherited |
Causes automatic repaints when the mouse enters or exits this component.
If turned on, then when the mouse enters/exits, or when the button is pressed/released on the component, it will trigger a repaint.
This is handy for things like buttons that need to draw themselves differently when the mouse moves over them, and it avoids having to override all the different mouse callbacks and call repaint().
|
inherited |
|
noexceptinherited |
Sets whether a row should be selected when the mouse is pressed or released.
By default this is true, but you may want to turn it off.
|
inherited |
Sets the rows that should be selected, based on an explicit set of ranges.
If sendNotificationEventToModel is true, the ListBoxModel::selectedRowsChanged() method will be called. If it's false, no notification will be sent to the model.
Changes the size of the component.
A synchronous call to resized() will occur if the size actually changes.
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to whatever bounds you set for it.
Referenced by juce::CarbonViewWrapperComponent::setOurSizeToEmbeddedViewSize().
|
inlinevirtualinherited |
Assigns a new tooltip to this object.
Reimplemented in juce::ComboBox, juce::Button, and juce::FilenameComponent.
Moves the component to a new position.
Changes the component's top-left position (without changing its size). The position is relative to the top-left of the component's parent.
If the component actually moves, this method will make a synchronous call to moved().
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to whatever bounds you set for it.
Moves the component to a new position.
Changes the component's top-left position (without changing its size). The position is relative to the top-left of the component's parent.
If the component actually moves, this method will make a synchronous call to moved().
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to whatever bounds you set for it.
Moves the component to a new position.
Changes the position of the component's top-right corner (keeping it the same size). The position is relative to the top-left of the component's parent.
If the component actually moves, this method will make a synchronous call to moved().
Note that if you've used setTransform() to apply a transform, then the component's bounds will no longer be a direct reflection of the position at which it appears within its parent, as the transform will be applied to whatever bounds you set for it.
|
inherited |
Sets a transform matrix to be applied to this component.
If you set a transform for a component, the component's position will be warped by it, relative to the component's parent's top-left origin. This means that the values you pass into setBounds() will no longer reflect the actual area within the parent that the component covers, as the bounds will be transformed and the component will probably end up actually appearing somewhere else within its parent.
When using transforms you need to be extremely careful when converting coordinates between the coordinate spaces of different components or the screen - you should always use getLocalPoint(), getLocalArea(), etc to do this, and never just manually add a component's position to a point in order to convert it between different components (but I'm sure you would never have done that anyway...).
Currently, transforms are not supported for desktop windows, so the transform will be ignored if you put a component on the desktop.
To remove a component's transform, simply pass AffineTransform() as the parameter to this method.
|
inherited |
Scrolls the list to a particular position.
The proportion is between 0 and 1.0, so 0 scrolls to the top of the list, 1.0 scrolls to the bottom.
If the total number of rows all fit onto the screen at once, then this method won't do anything.
|
inlinenoexceptinherited |
|
virtualinherited |
Makes the component visible or invisible.
This method will show or hide the component. Note that components default to being non-visible when first created. Also note that visible components won't be seen unless all their parent components are also visible.
This method will call visibilityChanged() and also componentVisibilityChanged() for any component listeners that are interested in this component.
| shouldBeVisible | whether to show or hide the component |
Reimplemented in juce::ScrollBar.
|
noexceptinherited |
Sets a flag to indicate whether this component needs keyboard focus or not.
By default components aren't actually interested in gaining the focus, but this method can be used to turn this on.
See the grabKeyboardFocus() method for details about the way a component is chosen to receive the focus.
|
inherited |
|
overridevirtual |
Reimplemented from juce::TableHeaderComponent::Listener.
|
overridevirtual |
Implements juce::TableHeaderComponent::Listener.
|
overridevirtual |
Implements juce::TableHeaderComponent::Listener.
|
overridevirtual |
Implements juce::TableHeaderComponent::Listener.
|
inherited |
Changes this component's z-order to be at the back of all its siblings.
If the component is set to be 'always-on-top', it will only be moved to the back of the other other 'always-on-top' components.
|
inherited |
|
inherited |
Brings the component to the front of its siblings.
If some of the component's siblings have had their 'always-on-top' flag set, then they will still be kept in front of this one (unless of course this one is also 'always-on-top').
| shouldAlsoGainFocus | if true, this will also try to assign keyboard focus to the component (see grabKeyboardFocus() for more details) |
Referenced by juce::CarbonViewWrapperComponent::carbonEventHandler().
|
staticinherited |
If any component has keyboard focus, this will defocus it.
|
private |
|
inherited |
Causes the list to refresh its content.
Call this when the number of rows in the list changes, or if you want it to call refreshComponentForRow() on all the row components.
This must only be called from the main message thread.
|
inherited |
Forces the current mouse cursor to be updated.
If you're overriding the getMouseCursor() method to control which cursor is displayed, then this will only be checked each time the user moves the mouse. So if you want to force the system to check that the cursor being displayed is up-to-date (even if the mouse is just sitting there), call this method.
(If you're changing the cursor using setMouseCursor(), you don't need to bother calling this).
|
virtualinherited |
For components on the desktop, this is called if the system wants to close the window.
This is a signal that either the user or the system wants the window to close. The default implementation of this method will trigger an assertion to warn you that your component should do something about it, but you can override this to ignore the event if you want.
Reimplemented in juce::AlertWindow.
|
overridevirtualinherited |
Reimplemented from juce::Component.
|
private |
|
private |
|
private |
|
private |
1.8.13