Skip to content

Commit 8776591

Browse files
RBridRBrid
authored
Renaming a few Scroller/ScrollViewer APIs (#185)
* Fixing Scroller's SnapPointsWithInvalidArgsThrow test. * Renaming enum ScrollerState to InteractionState. Renaming its enum values Interacting to Interaction and CustomAnimation to Animation. * Updating ScrollBarVisibility enum. Replacing Collapsed with Hidden.
1 parent 87fb4a5 commit 8776591

12 files changed

+32
-32
lines changed

‎dev/ParallaxView/APITests/ParallaxViewTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
using Scroller = Microsoft.UI.Xaml.Controls.Primitives.Scroller;
3434
using ScrollerChangeOffsetsOptions = Microsoft.UI.Xaml.Controls.ScrollerChangeOffsetsOptions;
3535
using ScrollerChangeZoomFactorOptions = Microsoft.UI.Xaml.Controls.ScrollerChangeZoomFactorOptions;
36-
using ScrollerState = Microsoft.UI.Xaml.Controls.ScrollerState;
36+
using InteractionState = Microsoft.UI.Xaml.Controls.InteractionState;
3737
using ScrollerViewChangeKind = Microsoft.UI.Xaml.Controls.ScrollerViewChangeKind;
3838
using ScrollerViewChangeSnapPointRespect = Microsoft.UI.Xaml.Controls.ScrollerViewChangeSnapPointRespect;
3939
using ScrollerViewKind = Microsoft.UI.Xaml.Controls.ScrollerViewKind;
@@ -1941,7 +1941,7 @@ private static void ChangeScrollerView(
19411941
try
19421942
{
19431943
Log.Comment("Scroller.StateChanged - State={0}", scroller.State);
1944-
if (scroller.State == ScrollerState.Idle)
1944+
if (scroller.State == InteractionState.Idle)
19451945
{
19461946
Log.Comment("Scroller - idling notification. Final view: {0}, {1}, {2}", scroller.HorizontalOffset, scroller.VerticalOffset, scroller.ZoomFactor);
19471947
scrollerStateChangedEvent.Set();

‎dev/ScrollViewer/ScrollViewer.cpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,14 @@ double ScrollViewer::ExtentHeight()
9393
return 0.0;
9494
}
9595

96-
winrt::ScrollerState ScrollViewer::State()
96+
winrt::InteractionState ScrollViewer::State()
9797
{
9898
if (auto scroller = m_scroller.get())
9999
{
100100
return scroller.State();
101101
}
102102

103-
return winrt::ScrollerState::Idle;
103+
return winrt::InteractionState::Idle;
104104
}
105105

106106
winrt::ScrollerInputKind ScrollViewer::InputKind()
@@ -636,7 +636,7 @@ void ScrollViewer::OnScrollerStateChanged(
636636

637637
if (auto scroller = m_scroller.get())
638638
{
639-
if (scroller.State() == winrt::ScrollerState::Interacting)
639+
if (scroller.State() == winrt::InteractionState::Interaction)
640640
{
641641
m_preferMouseIndicators = false;
642642
}

‎dev/ScrollViewer/ScrollViewer.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class ScrollViewer :
5151

5252
double ExtentHeight();
5353

54-
winrt::ScrollerState State();
54+
winrt::InteractionState State();
5555

5656
winrt::ScrollerInputKind InputKind();
5757
void InputKind(winrt::ScrollerInputKind const& value);

‎dev/ScrollViewer/ScrollViewer.idl

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
[webhosthidden]
33
enum ScrollBarVisibility
44
{
5-
Visible = 0,
6-
Collapsed = 1,
7-
Auto = 2,
5+
Auto = 0,
6+
Visible = 1,
7+
Hidden = 2,
88
};
99

1010
[WUXC_VERSION_PREVIEW]
@@ -22,7 +22,7 @@ unsealed runtimeclass ScrollViewer : Windows.UI.Xaml.Controls.Control
2222
Single ZoomFactor { get; };
2323
Double ExtentWidth { get; };
2424
Double ExtentHeight { get; };
25-
ScrollerState State { get; };
25+
InteractionState State { get; };
2626
MU_XCP_NAMESPACE.IScrollController HorizontalScrollController { get; };
2727
MU_XCP_NAMESPACE.IScrollController VerticalScrollController { get; };
2828
[MUX_DEFAULT_VALUE("ScrollViewer::s_defaultHorizontalScrollBarVisibility")]

‎dev/Scroller/APITests/ScrollerTests.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
#endif
3131

3232
#if !BUILD_WINDOWS
33-
using ScrollerState = Microsoft.UI.Xaml.Controls.ScrollerState;
33+
using InteractionState = Microsoft.UI.Xaml.Controls.InteractionState;
3434
using ScrollerScrollMode = Microsoft.UI.Xaml.Controls.ScrollerScrollMode;
3535
using ScrollerZoomMode = Microsoft.UI.Xaml.Controls.ScrollerZoomMode;
3636
using ScrollerChainingMode = Microsoft.UI.Xaml.Controls.ScrollerChainingMode;
@@ -47,7 +47,7 @@ namespace Windows.UI.Xaml.Tests.MUXControls.ApiTests
4747
[TestClass]
4848
public partial class ScrollerTests
4949
{
50-
private const ScrollerState c_defaultState = ScrollerState.Idle;
50+
private const InteractionState c_defaultState = InteractionState.Idle;
5151
private const ScrollerChainingMode c_defaultHorizontalScrollChainingMode = ScrollerChainingMode.Auto;
5252
private const ScrollerChainingMode c_defaultVerticalScrollChainingMode = ScrollerChainingMode.Auto;
5353
private const ScrollerRailingMode c_defaultHorizontalScrollRailingMode = ScrollerRailingMode.Enabled;

‎dev/Scroller/Scroller.cpp

+9-9
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ void Scroller::InputKind(winrt::ScrollerInputKind const& value)
366366
SetValue(s_InputKindProperty, box_value(value));
367367
}
368368

369-
winrt::ScrollerState Scroller::State()
369+
winrt::InteractionState Scroller::State()
370370
{
371371
return m_state;
372372
}
@@ -832,15 +832,15 @@ void Scroller::CustomAnimationStateEntered(
832832
{
833833
SCROLLER_TRACE_INFO(*this, TRACE_MSG_METH_INT, METH_NAME, this, args.RequestId());
834834

835-
UpdateState(winrt::ScrollerState::CustomAnimation);
835+
UpdateState(winrt::InteractionState::Animation);
836836
}
837837

838838
void Scroller::IdleStateEntered(
839839
const winrt::InteractionTrackerIdleStateEnteredArgs& args)
840840
{
841841
SCROLLER_TRACE_INFO(*this, TRACE_MSG_METH_INT, METH_NAME, this, args.RequestId());
842842

843-
UpdateState(winrt::ScrollerState::Idle);
843+
UpdateState(winrt::InteractionState::Idle);
844844

845845
if (!m_interactionTrackerAsyncOperations.empty())
846846
{
@@ -897,15 +897,15 @@ void Scroller::InertiaStateEntered(
897897
TypeLogging::Float2ToString(m_endOfInertiaPosition).c_str(),
898898
m_endOfInertiaZoomFactor);
899899

900-
UpdateState(winrt::ScrollerState::Inertia);
900+
UpdateState(winrt::InteractionState::Inertia);
901901
}
902902

903903
void Scroller::InteractingStateEntered(
904904
const winrt::InteractionTrackerInteractingStateEnteredArgs& args)
905905
{
906906
SCROLLER_TRACE_INFO(*this, TRACE_MSG_METH_INT, METH_NAME, this, args.RequestId());
907907

908-
UpdateState(winrt::ScrollerState::Interacting);
908+
UpdateState(winrt::InteractionState::Interaction);
909909

910910
if (!m_interactionTrackerAsyncOperations.empty())
911911
{
@@ -1022,7 +1022,7 @@ float Scroller::ComputeChildLayoutOffsetDelta(ScrollerDimension dimension, float
10221022

10231023
float Scroller::ComputeEndOfInertiaZoomFactor() const
10241024
{
1025-
if (m_state == winrt::ScrollerState::Inertia)
1025+
if (m_state == winrt::InteractionState::Inertia)
10261026
{
10271027
float endOfInertiaZoomFactor = m_endOfInertiaZoomFactor;
10281028

@@ -1039,7 +1039,7 @@ float Scroller::ComputeEndOfInertiaZoomFactor() const
10391039

10401040
winrt::float2 Scroller::ComputeEndOfInertiaPosition()
10411041
{
1042-
if (m_state == winrt::ScrollerState::Inertia)
1042+
if (m_state == winrt::InteractionState::Inertia)
10431043
{
10441044
float endOfInertiaZoomFactor = ComputeEndOfInertiaZoomFactor();
10451045
winrt::float2 minPosition{};
@@ -4521,7 +4521,7 @@ void Scroller::UpdateTransformSource(
45214521
}
45224522

45234523
void Scroller::UpdateState(
4524-
const winrt::ScrollerState& state)
4524+
const winrt::InteractionState& state)
45254525
{
45264526
if (state != m_state)
45274527
{
@@ -5575,7 +5575,7 @@ void Scroller::PostProcessZoomFactorChange(
55755575
// Returns True when an interruption was performed.
55765576
bool Scroller::InterruptViewChangeWithAnimation(InteractionTrackerAsyncOperationType interactionTrackerAsyncOperationType)
55775577
{
5578-
if (m_state == winrt::ScrollerState::CustomAnimation &&
5578+
if (m_state == winrt::InteractionState::Animation &&
55795579
interactionTrackerAsyncOperationType == m_lastInteractionTrackerAsyncOperationType &&
55805580
SharedHelpers::IsRS5OrHigher() &&
55815581
!SharedHelpers::Is19H1OrHigher())

‎dev/Scroller/Scroller.h

+3-3
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ class Scroller :
144144
winrt::ScrollerInputKind InputKind();
145145
void InputKind(winrt::ScrollerInputKind const& value);
146146

147-
winrt::ScrollerState State();
147+
winrt::InteractionState State();
148148

149149
winrt::IVector<winrt::ScrollerSnapPointBase> HorizontalSnapPoints();
150150

@@ -324,7 +324,7 @@ class Scroller :
324324
const winrt::UIElement& oldChild,
325325
const winrt::UIElement& newChild);
326326
void UpdateState(
327-
const winrt::ScrollerState& state);
327+
const winrt::InteractionState& state);
328328
void UpdateExpressionAnimationSources();
329329
void UpdateUnzoomedExtentAndViewport(
330330
double unzoomedExtentWidth, double unzoomedExtentHeight,
@@ -676,7 +676,7 @@ class Scroller :
676676
std::vector<tracker_ref<winrt::UIElement>> m_anchorCandidates;
677677
std::list<std::shared_ptr<InteractionTrackerAsyncOperation>> m_interactionTrackerAsyncOperations;
678678
winrt::Rect m_anchorElementBounds{};
679-
winrt::ScrollerState m_state{ winrt::ScrollerState::Idle };
679+
winrt::InteractionState m_state{ winrt::InteractionState::Idle };
680680
winrt::IInspectable m_pointerPressedEventHandler{ nullptr };
681681
winrt::CompositionPropertySet m_expressionAnimationSources{ nullptr };
682682
winrt::CompositionPropertySet m_horizontalScrollControllerExpressionAnimationSources{ nullptr };

‎dev/Scroller/Scroller.idl

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[WUXC_VERSION_PREVIEW]
22
[webhosthidden]
3-
enum ScrollerState
3+
enum InteractionState
44
{
55
Idle = 0,
6-
Interacting = 1,
6+
Interaction = 1,
77
Inertia = 2,
8-
CustomAnimation = 3,
8+
Animation = 3,
99
};
1010

1111
[WUXC_VERSION_PREVIEW]

‎dev/Scroller/ScrollerAnchoring.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ void Scroller::IsAnchoring(
8787
// removing the check is the correct fix due to dcomp bug 17523225. I filed a
8888
// tracking bug to follow up once the dcomp bug is fixed.
8989
// Bug 17523266: Scroller is not anchoring during mouse wheel
90-
if (!m_interactionTracker || m_state == winrt::ScrollerState::CustomAnimation)
90+
if (!m_interactionTracker || m_state == winrt::InteractionState::Animation)
9191
{
9292
// Skip calls to SetChildLayoutOffsetX / SetChildLayoutOffsetY when the InteractionTracker has not been set up yet,
9393
// or when it is performing a custom animation because if would result in a visual flicker.

‎dev/Scroller/ScrollerPrimitives.idl

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ unsealed runtimeclass Scroller : Windows.UI.Xaml.FrameworkElement
154154
[MUX_DEFAULT_VALUE("Scroller::s_defaultMaxZoomFactor")]
155155
[MUX_PROPERTY_VALIDATION_CALLBACK("ValidateZoomFactoryBoundary")]
156156
Double MaxZoomFactor { get; set; };
157-
MU_XC_NAMESPACE.ScrollerState State { get; };
157+
MU_XC_NAMESPACE.InteractionState State { get; };
158158
IScrollController HorizontalScrollController { get; set; };
159159
IScrollController VerticalScrollController { get; set; };
160160
[MUX_DEFAULT_VALUE("Scroller::s_defaultAnchorAtExtent")]

‎dev/Scroller/TestUI/ScrollerChainingAndRailingPage.xaml.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ public ScrollerChainingAndRailingPage()
4848

4949
private void ScrollViewer2_DirectManipulationStarted(object sender, object e)
5050
{
51-
txtScrollViewer2State.Text = (sender as ScrollViewer).Name + " Interacting";
51+
txtScrollViewer2State.Text = (sender as ScrollViewer).Name + " Interaction";
5252
txtScrollViewer2HSP.Text = String.Format("{0,5:N1}%", (sender as ScrollViewer).HorizontalOffset / (sender as ScrollViewer).ScrollableWidth * 100.0);
5353
txtScrollViewer2VSP.Text = String.Format("{0,5:N1}%", (sender as ScrollViewer).VerticalOffset / (sender as ScrollViewer).ScrollableHeight * 100.0);
5454
}

‎dev/Telemetry/TypeLogging.cpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ winrt::hstring TypeLogging::ScrollBarVisibilityToString(const winrt::ScrollBarVi
9494
{
9595
case winrt::ScrollBarVisibility::Visible:
9696
return L"Visible";
97-
case winrt::ScrollBarVisibility::Collapsed:
98-
return L"Collapsed";
97+
case winrt::ScrollBarVisibility::Hidden:
98+
return L"Hidden";
9999
case winrt::ScrollBarVisibility::Auto:
100100
return L"Auto";
101101
default:

0 commit comments

Comments
 (0)