Let teachingtip treat placement logically not physically #3165
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| #include "pch.h" | ||
| #include "common.h" | ||
| #include "TeachingTip.h" | ||
| #include "RuntimeProfiler.h" | ||
|
|
@@ -556,7 +556,7 @@ bool TeachingTip::PositionUntargetedPopup() | |
| // offset property to determine the appropriate vertical and horizontal offsets of the popup that the tip is contained in. | ||
| if (auto&& popup = m_popup.get()) | ||
| { | ||
| switch (GetFlowDirectionAdjustedPlacement(PreferredPlacement())) | ||
| { | ||
| case winrt::TeachingTipPlacementMode::Auto: | ||
| case winrt::TeachingTipPlacementMode::Bottom: | ||
|
|
@@ -1343,6 +1343,49 @@ void TeachingTip::ClosePopup() | |
| } | ||
| } | ||
|
|
||
| winrt::TeachingTipPlacementMode TeachingTip::GetFlowDirectionAdjustedPlacement(const winrt::TeachingTipPlacementMode& placementMode) | ||
|
There was a problem hiding this comment.
@jevansaks do you remember why we didn't do this for the initial check in? I know that we talked about it but I can't recall what we got hung up on. There was a problem hiding this comment. Sorry, unfortunately I don't remember either. |
||
| { | ||
| if (FlowDirection() == winrt::FlowDirection::LeftToRight) | ||
| { | ||
| return placementMode; | ||
| } | ||
| else | ||
| { | ||
| switch (placementMode) | ||
| { | ||
| case winrt::TeachingTipPlacementMode::Auto: | ||
| return winrt::TeachingTipPlacementMode::Auto; | ||
| case winrt::TeachingTipPlacementMode::Left: | ||
| return winrt::TeachingTipPlacementMode::Right; | ||
| case winrt::TeachingTipPlacementMode::Right: | ||
| return winrt::TeachingTipPlacementMode::Left; | ||
| case winrt::TeachingTipPlacementMode::Top: | ||
| return winrt::TeachingTipPlacementMode::Top; | ||
| case winrt::TeachingTipPlacementMode::Bottom: | ||
| return winrt::TeachingTipPlacementMode::Bottom; | ||
| case winrt::TeachingTipPlacementMode::LeftBottom: | ||
| return winrt::TeachingTipPlacementMode::RightBottom; | ||
| case winrt::TeachingTipPlacementMode::LeftTop: | ||
| return winrt::TeachingTipPlacementMode::RightTop; | ||
| case winrt::TeachingTipPlacementMode::TopLeft: | ||
| return winrt::TeachingTipPlacementMode::TopRight; | ||
| case winrt::TeachingTipPlacementMode::TopRight: | ||
| return winrt::TeachingTipPlacementMode::TopLeft; | ||
| case winrt::TeachingTipPlacementMode::RightTop: | ||
| return winrt::TeachingTipPlacementMode::LeftTop; | ||
| case winrt::TeachingTipPlacementMode::RightBottom: | ||
| return winrt::TeachingTipPlacementMode::LeftBottom; | ||
| case winrt::TeachingTipPlacementMode::BottomRight: | ||
| return winrt::TeachingTipPlacementMode::BottomLeft; | ||
| case winrt::TeachingTipPlacementMode::BottomLeft: | ||
| return winrt::TeachingTipPlacementMode::BottomRight; | ||
| case winrt::TeachingTipPlacementMode::Center: | ||
| return winrt::TeachingTipPlacementMode::Center; | ||
| } | ||
| } | ||
| return winrt::TeachingTipPlacementMode::Auto; | ||
|
There was a problem hiding this comment.
Is this needed? There was a problem hiding this comment. Either this or a default cause for our switch case, otherwise not all code paths would return a value according to the compiler. |
||
| } | ||
|
|
||
| void TeachingTip::OnTargetChanged() | ||
| { | ||
| m_targetLayoutUpdatedRevoker.revoke(); | ||
|
|
@@ -1668,7 +1711,7 @@ std::tuple<winrt::TeachingTipPlacementMode, bool> TeachingTip::DetermineEffectiv | |
| // SetReturnTopForOutOfWindowBounds test hook. | ||
| if (!ShouldConstrainToRootBounds() && m_returnTopForOutOfWindowPlacement) | ||
| { | ||
| auto const placement = GetFlowDirectionAdjustedPlacement(PreferredPlacement()); | ||
| if (placement == winrt::TeachingTipPlacementMode::Auto) | ||
| { | ||
| return std::make_tuple(winrt::TeachingTipPlacementMode::Top, false); | ||
|
|
@@ -1893,7 +1936,8 @@ std::tuple<winrt::TeachingTipPlacementMode, bool> TeachingTip::DetermineEffectiv | |
| availability[winrt::TeachingTipPlacementMode::RightBottom] = false; | ||
| } | ||
|
|
||
| auto const wantedDirection = GetFlowDirectionAdjustedPlacement(PreferredPlacement()); | ||
| auto const priorities = GetPlacementFallbackOrder(wantedDirection); | ||
|
|
||
| for (auto const mode : priorities) | ||
| { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Really? what happens? was that the case before this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not entirely sure what the root cause is, however when running those tests locally, I noticed that the rect (and the red border we use to show it) don't always show up. The problem is that this leaves the TeachingTip to believe it has more space and fails the test.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why wasn't this causing the test to fail before this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The test was very unreliable on my machine before that change, only 20% of the time it actually ran through.