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

Docs: Update Component docs referencing deprecated setFocusContainer() method

Browse source
This commit is contained in:
ed 2021-12-01 10:22:19 +00:00
parent 4471efd1c5
commit bd01175d55
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
modules/juce_gui_basics/components/juce_Component.h
View file

@ -1261,7 +1261,7 @@ public:
*/
int getExplicitFocusOrder() const;
/** A focus container type that can be passed to setFocusContainer().
/** A focus container type that can be passed to setFocusContainerType().
If a component is marked as a focus container or keyboard focus container then
it will act as the top-level component within which focus or keyboard focus is
@ -1318,25 +1318,25 @@ public:
/** Returns true if this component has been marked as a focus container.
@see setFocusContainer
@see setFocusContainerType
*/
bool isFocusContainer() const noexcept;
/** Returns true if this component has been marked as a keyboard focus container.
@see setFocusContainer
@see setFocusContainerType
*/
bool isKeyboardFocusContainer() const noexcept;
/** Returns the focus container for this component.
@see isFocusContainer, setFocusContainer
@see isFocusContainer, setFocusContainerType
*/
Component* findFocusContainer() const;
/** Returns the keyboard focus container for this component.
@see isFocusContainer, setFocusContainer
@see isFocusContainer, setFocusContainerType
*/
Component* findKeyboardFocusContainer() const;
@ -1434,7 +1434,7 @@ public:
@param moveToNext if true, the focus will move forwards; if false, it will
move backwards
@see grabKeyboardFocus, giveAwayKeyboardFocus, setFocusContainer, setWantsKeyboardFocus
@see grabKeyboardFocus, giveAwayKeyboardFocus, setFocusContainerType, setWantsKeyboardFocus
*/
void moveKeyboardFocusToSibling (bool moveToNext);
@ -1452,8 +1452,8 @@ public:
passed from this component.
The default implementation of this method will return an instance of FocusTraverser
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 call
if this component is a focus container (as determined by the setFocusContainerType()
method). If the component isn't a focus container, then it will recursively call
createFocusTraverser() on its parents.
If you override this to return a custom traverser object, then this component and
@ -1466,8 +1466,8 @@ public:
The default implementation of this method will return an instance of
KeyboardFocusTraverser if this component is a keyboard focus container (as determined by
the setFocusContainer() method). If the component isn't a keyboard focus container, then
it will recursively call createKeyboardFocusTraverser() on its parents.
the setFocusContainerType() method). If the component isn't a keyboard focus container,
then it will recursively call createKeyboardFocusTraverser() on its parents.
If you override this to return a custom traverser object, then this component and
all its sub-components will use the new object to make their keyboard focusing