mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Made the documentation of some classes clearer regarding when a notification will be sent

Browse source
This commit is contained in:
ed 2017-12-28 17:02:58 +00:00
parent c1c325c782
commit 9bb4e025ca
5 changed files with 44 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
modules/juce_gui_basics/filebrowser/juce_FilenameComponent.h
View file

@ -112,7 +112,8 @@ public:
@param newFile the new filename to use
@param addToRecentlyUsedList if true, the filename will also be added to the
drop-down list of recent files.
@param notification whether to send a notification of the change to listeners
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the filename has changed.
*/
void setCurrentFile (File newFile,
bool addToRecentlyUsedList,

27
modules/juce_gui_basics/layout/juce_ScrollBar.h
View file

@ -95,6 +95,10 @@ public:
The bar's thumb will always be constrained so that the entire thumb lies
within this range.
@param newRangeLimit the new range.
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the range has changed.
@see setCurrentRange
*/
void setRangeLimits (Range<double> newRangeLimit,
@ -105,6 +109,11 @@ public:
The bar's thumb will always be constrained so that the entire thumb lies
within this range.
@param minimum the new range minimum.
@param maximum the new range maximum.
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the range has changed.
@see setCurrentRange
*/
void setRangeLimits (double minimum, double maximum,
@ -208,6 +217,11 @@ public:
A positive value here will move the bar down or to the right, a negative
value moves it up or to the left.
@param howManySteps the number of steps to move the scrollbar
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the position has changed.
@returns true if the scrollbar's position actually changed.
*/
bool moveScrollbarInSteps (int howManySteps,
@ -220,6 +234,11 @@ public:
A positive value here will move the bar down or to the right, a negative
value moves it up or to the left.
@param howManyPages the number of pages to move the scrollbar
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the position has changed.
@returns true if the scrollbar's position actually changed.
*/
bool moveScrollbarInPages (int howManyPages,
@ -227,12 +246,20 @@ public:
/** Scrolls to the top (or left).
This is the same as calling setCurrentRangeStart (getMinimumRangeLimit());
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the position has changed.
@returns true if the scrollbar's position actually changed.
*/
bool scrollToTop (NotificationType notification = sendNotificationAsync);
/** Scrolls to the bottom (or right).
This is the same as calling setCurrentRangeStart (getMaximumRangeLimit() - getCurrentRangeSize());
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the position has changed.
@returns true if the scrollbar's position actually changed.
*/
bool scrollToBottom (NotificationType notification = sendNotificationAsync);

12
modules/juce_gui_basics/widgets/juce_Slider.h
View file

@ -377,7 +377,8 @@ public:
nearest interval if one has been set
@param notification can be one of the NotificationType values, to request
a synchronous or asynchronous call to the valueChanged() method
of any Slider::Listeners that are registered.
of any Slider::Listeners that are registered. A notification will
only be sent if the Slider's value has changed.
*/
void setValue (double newValue, NotificationType notification = sendNotificationAsync);
@ -460,7 +461,8 @@ public:
interval if one has been set.
@param notification can be one of the NotificationType values, to request
a synchronous or asynchronous call to the valueChanged() method
of any Slider::Listeners that are registered.
of any Slider::Listeners that are registered. A notification will
only be sent if this value has changed.
@param allowNudgingOfOtherValues if false, this value will be restricted to being below the
max value (in a two-value slider) or the mid value (in a three-value
slider). If true, then if this value goes beyond those values,
@ -500,7 +502,8 @@ public:
interval if one has been set.
@param notification can be one of the NotificationType values, to request
a synchronous or asynchronous call to the valueChanged() method
of any Slider::Listeners that are registered.
of any Slider::Listeners that are registered. A notification will
only be sent if this value has changed.
@param allowNudgingOfOtherValues if false, this value will be restricted to being above the
min value (in a two-value slider) or the mid value (in a three-value
slider). If true, then if this value goes beyond those values,
@ -523,7 +526,8 @@ public:
nearest interval if one has been set.
@param notification can be one of the NotificationType values, to request
a synchronous or asynchronous call to the valueChanged() method
of any Slider::Listeners that are registered.
of any Slider::Listeners that are registered. A notification will
only be sent if one or more of the values has changed.
@see setMaxValue, setMinValue, setValue
*/
void setMinAndMaxValues (double newMinValue, double newMaxValue,

2
modules/juce_gui_basics/widgets/juce_TreeView.h
View file

@ -182,7 +182,7 @@ public:
/** Selects or deselects the item.
If shouldNotify == sendNotification, then a callback will be made
to itemSelectionChanged()
to itemSelectionChanged() if the item's selection has changed.
*/
void setSelected (bool shouldBeSelected,
bool deselectOtherItemsFirst,

7
modules/juce_gui_extra/misc/juce_ColourSelector.h
View file

@ -80,7 +80,12 @@ public:
*/
Colour getCurrentColour() const;
/** Changes the colour that is currently being shown. */
/** Changes the colour that is currently being shown.
@param newColour the new colour to show
@param notification whether to send a notification of the change to listeners.
A notification will only be sent if the colour has changed.
*/
void setCurrentColour (Colour newColour, NotificationType notificationType = sendNotification);
//==============================================================================