#include <juce_LassoComponent.h>
Public Types | |
| enum | ColourIds { lassoFillColourId = 0x1000440 , lassoOutlineColourId = 0x1000441 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Private Attributes | |
| Array< SelectableItemType > | originalSelection |
| LassoSource< SelectableItemType > * | source = nullptr |
| Point< int > | dragStartPos |
Additional Inherited Members | |
| Static Public Member Functions inherited from juce::Component | |
| static float JUCE_CALLTYPE | getApproximateScaleFactorForComponent (const Component *targetComponent) |
| static Component *JUCE_CALLTYPE | getCurrentlyFocusedComponent () noexcept |
| static void JUCE_CALLTYPE | unfocusAllComponents () |
| static void JUCE_CALLTYPE | beginDragAutoRepeat (int millisecondsBetweenCallbacks) |
| static bool JUCE_CALLTYPE | isMouseButtonDownAnywhere () noexcept |
| static int JUCE_CALLTYPE | getNumCurrentlyModalComponents () noexcept |
| static Component *JUCE_CALLTYPE | getCurrentlyModalComponent (int index=0) noexcept |
| Protected Member Functions inherited from juce::Component | |
| virtual ComponentPeer * | createNewPeer (int styleFlags, void *nativeWindowToAttachTo) |
| Static Protected Member Functions inherited from juce::Component | |
| static std::unique_ptr< AccessibilityHandler > | createIgnoredAccessibilityHandler (Component &) |
Detailed Description
class juce::LassoComponent< SelectableItemType >
A component that acts as a rectangular selection region, which you drag with the mouse to select groups of objects (in conjunction with a SelectedItemSet).
To use one of these:
- In your mouseDown or mouseDrag event, add the LassoComponent to your parent component, and call its beginLasso() method, giving it a suitable LassoSource object that it can use to find out which items are in the active area.
- Each time your parent component gets a mouseDrag event, call dragLasso() to update the lasso's position - it will use its LassoSource to calculate and update the current selection.
- After the drag has finished and you get a mouseUp callback, you should call endLasso() to clean up. This will make the lasso component invisible, and you can remove it from the parent component, or delete it.
The class takes into account the modifier keys that are being held down while the lasso is being dragged, so if shift is pressed, then any lassoed items will be added to the original selection; if ctrl or command is pressed, they will be xor'ed with any previously selected items.
- See also
- LassoSource, SelectedItemSet
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::LassoComponent::ColourIds |
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.
Note that you can also use the constants from TextEditor::ColourIds to change the colour of the text editor that is opened when a label is editable.
- See also
- Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
| Enumerator | |
|---|---|
| lassoFillColourId | The colour to fill the lasso rectangle with. |
| lassoOutlineColourId | The colour to draw the outline with. |
Constructor & Destructor Documentation
◆ LassoComponent()
|
default |
Creates a Lasso component.
Member Function Documentation
◆ beginLasso()
|
inline |
Call this in your mouseDown event, to initialise a drag.
Pass in a suitable LassoSource object which the lasso will use to find the items and change the selection.
After using this method to initialise the lasso, repeatedly call dragLasso() in your component's mouseDrag callback.
- See also
- dragLasso, endLasso, LassoSource
◆ dragLasso()
|
inline |
Call this in your mouseDrag event, to update the lasso's position.
This must be repeatedly calling when the mouse is dragged, after you've first initialised the lasso with beginLasso().
This method takes into account the modifier keys that are being held down, so if shift is pressed, then the lassoed items will be added to any that were previously selected; if ctrl or command is pressed, then they will be xor'ed with previously selected items.
- See also
- beginLasso, endLasso
◆ endLasso()
|
inline |
Call this in your mouseUp event, after the lasso has been dragged.
- See also
- beginLasso, dragLasso
◆ hitTest()
|
inlineoverridevirtual |
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.
- Parameters
-
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
- Returns
- true if the click is considered to be inside the component
- See also
- setInterceptsMouseClicks, contains
Reimplemented from juce::Component.
◆ paint()
|
inlineoverridevirtual |
Components can override this method to draw their content.
The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.
Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.
If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.
You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
Member Data Documentation
◆ dragStartPos
|
private |
◆ originalSelection
|
private |
◆ source
|
private |
The documentation for this class was generated from the following file:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/mouse/juce_LassoComponent.h
Generated on for LMMS by
1.16.1