sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-05-20 13:07:21 +09:00
Code Issues Packages Projects Releases Wiki Activity

Document and retouch ReportPopover

Browse Source
This commit is contained in:
Bartłomiej Dach 2023-05-06 14:52:33 +02:00
parent 8391e2a538
commit 52e5835be6
No known key found for this signature in database
2 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
osu.Game/Graphics/UserInterfaceV2/ReportPopover.cs
View File

@ -16,17 +16,29 @@ using osuTK;
namespace osu.Game.Graphics.UserInterfaceV2 namespace osu.Game.Graphics.UserInterfaceV2
{ {
public abstract partial class ReportPopover<T> : OsuPopover /// <summary>
where T : struct, Enum /// A generic popover for sending an online report about something.
/// </summary>
/// <typeparam name="TReportReason">An enumeration type with all valid reasons for the report.</typeparam>
public abstract partial class ReportPopover<TReportReason> : OsuPopover
where TReportReason : struct, Enum
{ {
public Action<T, string>? Action; /// <summary>
/// The action to run when the report is finalised.
/// The arguments to this action are: the reason for the report, and an optional additional comment.
/// </summary>
public Action<TReportReason, string>? Action;
private OsuEnumDropdown<T> reasonDropdown = null!; private OsuEnumDropdown<TReportReason> reasonDropdown = null!;
private OsuTextBox commentsTextBox = null!; private OsuTextBox commentsTextBox = null!;
private RoundedButton submitButton = null!; private RoundedButton submitButton = null!;
private readonly LocalisableString header; private readonly LocalisableString header;
/// <summary>
/// Creates a new <see cref="ReportPopover{TReportReason}"/>.
/// </summary>
/// <param name="headerString">The text to display in the header of the popover.</param>
protected ReportPopover(LocalisableString headerString) protected ReportPopover(LocalisableString headerString)
{ {
header = headerString; header = headerString;
@ -68,7 +80,7 @@ namespace osu.Game.Graphics.UserInterfaceV2
{ {
RelativeSizeAxes = Axes.X, RelativeSizeAxes = Axes.X,
Height = 40, Height = 40,
Child = reasonDropdown = new OsuEnumDropdown<T> Child = reasonDropdown = new OsuEnumDropdown<TReportReason>
{ {
RelativeSizeAxes = Axes.X RelativeSizeAxes = Axes.X
} }
@ -110,12 +122,12 @@ namespace osu.Game.Graphics.UserInterfaceV2
private void updateStatus() private void updateStatus()
{ {
submitButton.Enabled.Value = !string.IsNullOrWhiteSpace(commentsTextBox.Current.Value) || CheckCanSubmitEmptyComment(reasonDropdown.Current.Value); submitButton.Enabled.Value = !string.IsNullOrWhiteSpace(commentsTextBox.Current.Value) || IsCommentRequired(reasonDropdown.Current.Value);
} }
protected virtual bool CheckCanSubmitEmptyComment(T reason) /// <summary>
{ /// Determines whether an additional comment is required for submitting the report with the supplied <paramref name="reason"/>.
return false; /// </summary>
} protected virtual bool IsCommentRequired(TReportReason reason) => false;
} }
} }

5
osu.Game/Overlays/Chat/ReportChatPopover.cs
View File

@ -27,10 +27,7 @@ namespace osu.Game.Overlays.Chat
Action = report; Action = report;
} }
protected override bool CheckCanSubmitEmptyComment(ChatReportReason reason) protected override bool IsCommentRequired(ChatReportReason reason) => reason != ChatReportReason.Other;
{
return reason != ChatReportReason.Other;
}
private void report(ChatReportReason reason, string comments) private void report(ChatReportReason reason, string comments)
{ {