Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GUI: Adds Entry pages (BaseParameterPage, NestablePage) #95

Merged
merged 14 commits into from
Nov 4, 2024

Conversation

tangkong
Copy link
Contributor

@tangkong tangkong commented Oct 22, 2024

Description

Adds Pages for viewing and editing details for the other entry types.

  • Adds BaseParameterPage which dynamically shows and hides widgets based on which fields are present (Single PV Entries)
  • adds BusyCursorThread, for simple blocking work
  • slightly modify the signature of open_page_slot, but make a type alias for it so we get it right in the future
  • add save-button logic (save to client, disable/hide if not editable)
  • Add editable flag/toggle
  • complete nestable pages (Collection view, Snapshot view)
  • more tests

This is currently based on top of #96 , once that's in I'll rebase one last time

Motivation and Context

#65
#66
#67
#68

How Has This Been Tested?

I'll add tests I swear

Where Has This Been Documented?

This PR

A readback (has tolerances, no rbv)
image

A setpoint (no tolerances, has rbv)
image

Widgets update based on pv type
image

Pre-merge checklist

  • Code works interactively
  • Code follows the style guide
  • Code contains descriptive docstrings, including context and API
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions
  • Ran docs/pre-release-notes.sh and created a pre-release documentation page
  • Pre-release docs include context, functional descriptions, and contributors as appropriate

@tangkong tangkong changed the title WIP/GUI: Entry pages GUI: Adds Entry pages (BaseParameterPage, NestablePage) Oct 29, 2024
@tangkong tangkong marked this pull request as ready for review October 29, 2024 20:23

# a list of qtawesome icon names
icon_map = {
Collection: 'mdi.file-document-multiple',
Parameter: 'msc.symbol-field',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you try a few symbol variants? This one is somewhat unintuitive to me. Did something like mdi.file-document not work for some design reason?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I admittedly didn't think super hard about this, my mind was thinking of Parameters as a "building block" of sorts. But a single mdi.file-document combining into a Collection (file-document-multiple) makes a lot of sense, I was blind to the obvious thing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seeking other opinions here: is this too similar?
image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's certainly a bit closer than I'd like but I'm not sure
There's also an outline variant we could try

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternate thoughts, organized as Parameter -> Collection:

  • image -> image

  • image -> image (an unfilled file-document to further differentiate)

There are so many icons. I think I'll just use the second option here, before I get too creative with all of this.

ZLLentz
ZLLentz previously approved these changes Oct 31, 2024
Copy link
Member

@ZLLentz ZLLentz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked some questions but things look reasonable
I wasn't able to fully test myself because I couldn't get an editable entry page to appear from superscore's ui

@tangkong
Copy link
Contributor Author

tangkong commented Nov 4, 2024

A quick icon change, then I think we can get this in

@tangkong tangkong merged commit 5a251c1 into pcdshub:master Nov 4, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants