Add Progress bar for File/Save Project functionality , replacing busy cursor

[Abo-Omar-74]

Overview:

This pull request introduces significant improvements to the File/Save Project functionality by replacing the busy cursor with a dynamic progress bar dialog. The progress bar dialog provides users with informative feedback on the status of the save operation, enhancing the overall user experience.
Solving part of this issue #707

Changes Made:

• Added ProgressBarHandler Class:

  • Implemented a new class called ProgressBarHandler, which inherits from wx.ProgressDialog.
  • This class encapsulates the functionality of the progress bar dialog.

• Implemented Functions:

  • wasCancelled: Checks whether the progress dialog was cancelled by the user.
  • update: Updates the progress dialog with the current progress value.
  • close: Closes the progress dialog.
  • pulse: Provides visual feedback to indicate ongoing activity.

• Utilized Pubsub for Communication:

  • Integrated Pubsub for efficient communication between the SaveProject function and the ProgressBarHandler class.
  • Subscribed to Pubsub messages within the ProgressBarHandler class to handle updates and closing of the progress bar dialog.
  • Utilized Pubsub to send messages from the SaveProject function to update the progress bar dialog with relevant information.

Future Use:

• Base Class for Progress Bar Handling:
  • The ProgressBarHandler class serves as a foundational component for managing progress bar functionality in future enhancements.
  • Its modular design allows for customization and adaptation to various functionalities that may benefit from progress bar feedback and solve the full issue Add progress bar to load and save files #707 here.

video while testing

Screenshots:

[Abo-Omar-74]

It appears that I have removed 25 line from invesalius/control.py but actually all I have removed is 2 lines
which are :

• line no : 370 Publisher.sendMessage('Begin busy cursor')
• line no : 397 Publisher.sendMessage('End busy cursor')

and added line for Publisher.sendMessage related calls for updating and closing the Progress bar

I think this happen because of the indentation of Try Except that I have added to close the dialog if anything wrong occurred .

[vhosouza]

@Abo-Omar-74 thanks for the PR! This is a nice feature. However, due to recent changes to the dialogs.py module, your code has conflicts. Can you rebase it and then I will review it, please?

[Abo-Omar-74]

@Abo-Omar-74 thanks for the PR! This is a nice feature. However, due to recent changes to the dialogs.py module, your code has conflicts. Can you rebase it and then I will review it, please?

@vhosouza Thanks for reaching out! I have resolved the conflict. I eagerly await your review.

[vhosouza]

@Abo-Omar-74, thanks again for the adjustments. I tested and it's almost working fine. Just a couple of changes requested:

• Fix wasCanceled method naming
• Fix the "Cancel" behavior

[vhosouza]

Rename to follow the same lower case standard as the other methods.

[vhosouza]

Also, I tested in MacOS and as the progress bar starts, the busy cursor also starts and it prevents from clicking the button Cancel, which means that the saving was not canceled. This behavior needs to be fixed.

[vhosouza]

Also, in MacOS Sonoma, when the Progress Bar starts, the icon of invesalius is changed to a "folder" and after the bar is closed, the icon remains a folder. Any idea on how this can be fixed?

[Abo-Omar-74]

Code Modifications

@vhosouza , I am writing to provide an update regarding the recent code modifications in response to your feedback :

1. Renamed the function wasCancelled to was_cancelled as requested.

2. Disabled the cancel button due to the absence of an interrupt mechanism for the current saving functionality. This solution is still better than the current solution of the problem as it uses progress bar instead of a busy cursor, aiming for enhanced user experience.

3. In my attempt to address the interruption issue, I experimented with binding the cancel button event wx.EVT_CLOSE to a function named interrupt. This function raises an exception, which is subsequently caught by the try except block within the SaveProject function in invesalius/control.py.

I will continue to refine the interrupt mechanism to ensure smooth operation and will keep you updated on any progress or further insights.

Thank you for your guidance and support.