devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 6 Actions Packages Projects 1 Releases Wiki Activity

Add prof.get_current_window API to Retrieve Current Window Title #34

New Issue
Closed
opened 2025-10-01 05:57:40 +00:00 by jabber.developer · 1 comment
jabber.developer commented 2025-10-01 05:57:40 +00:00
Owner
Copy Link

Updated Issue

Description
Currently, the CProof's Python API provides functions like prof.get_current_recipient and prof.get_current_muc to retrieve context-specific information about the active chat. However, there is no way to retrieve the title of the currently active window, which is useful for plugins that need to display or act on the window's titlebar content (e.g., for UI customization or context-aware commands).

This is particularly crucial for plugin windows, where the title matches the window tag used for communication (e.g., in prof_win_show and similar API functions). Plugins rely on tags to target specific windows for operations like displaying messages. Retrieving the current window title allows plugins to dynamically obtain the tag if the active window is a plugin window, enabling seamless interaction without hardcoding tags.

Proposed Solution

  • Add prof.get_current_window() to the API that returns the title of the current window as a string, matching the titlebar display
  • Optionally, extend api_win_show (and similar functions) to support additional window types, such as falling back to cons_show for console or non-plugin windows if the tag doesn't match a plugin window.

This would align with existing context-retrieval functions and enhance plugin functionality.

Use Case

  • A plugin could use prof.get_current_window to get the title (tag for plugin windows) and then call prof.win_show(title, "Message") to display content in the active plugin window.
  • For non-plugin windows, an extended api_win_show could route to appropriate display functions (e.g., cons_show for console).

Acceptance Criteria:

  • Add prof.get_current_window() -> str to the Python API.
  • Add char* get_current_window() to the C API.
  • Ensure it returns the window title as shown in the titlebar, serving as the tag for plugin windows.
  • Update API documentation with function description, example, and note on plugin window tags.
  • Consider PR for extending api_win_show to handle non-plugin windows (e.g., via fallback to cons_show).
### Updated Issue **Description** Currently, the CProof's Python API provides functions like `prof.get_current_recipient` and `prof.get_current_muc` to retrieve context-specific information about the active chat. However, there is no way to retrieve the title of the currently active window, which is useful for plugins that need to display or act on the window's titlebar content (e.g., for UI customization or context-aware commands). This is particularly crucial for plugin windows, where the title matches the window tag used for communication (e.g., in `prof_win_show` and similar API functions). Plugins rely on tags to target specific windows for operations like displaying messages. Retrieving the current window title allows plugins to dynamically obtain the tag if the active window is a plugin window, enabling seamless interaction without hardcoding tags. **Proposed Solution** - Add `prof.get_current_window()` to the API that returns the title of the current window as a string, matching the titlebar display - Optionally, extend `api_win_show` (and similar functions) to support additional window types, such as falling back to `cons_show` for console or non-plugin windows if the tag doesn't match a plugin window. This would align with existing context-retrieval functions and enhance plugin functionality. **Use Case** - A plugin could use `prof.get_current_window` to get the title (tag for plugin windows) and then call `prof.win_show(title, "Message")` to display content in the active plugin window. - For non-plugin windows, an extended `api_win_show` could route to appropriate display functions (e.g., `cons_show` for console). **Acceptance Criteria**: - Add `prof.get_current_window() -> str` to the Python API. - Add `char* get_current_window()` to the C API. - Ensure it returns the window title as shown in the titlebar, serving as the tag for plugin windows. - Update API documentation with function description, example, and note on plugin window tags. - Consider PR for extending `api_win_show` to handle non-plugin windows (e.g., via fallback to `cons_show`).
jabber.developer added the
Kind/Enhancement
Reviewed
Confirmed
1
Priority
Medium
3
 labels 2025-10-01 05:57:40 +00:00
jabber.developer self-assigned this 2025-10-01 05:57:40 +00:00
jabber.developer commented 2025-11-10 08:40:05 +00:00
Author
Owner
Copy Link

Closed by #35

Closed by #35
jabber.developer added this to the Plans (2025-2026) project 2026-04-25 18:11:34 +00:00
jabber.developer moved this to Done in Plans (2025-2026) on 2026-04-25 18:11:47 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
Kind/Bug
Something is not working
Kind/Documentation
Documentation changes
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Kind/Enhancement
Priority
Medium
3
Reviewed
Confirmed
1
Milestone
No items
No Milestone
Projects
Clear projects
No project Plans (2025-2026)
Assignees
Clear assignees
admin jabber.developer jabber.developer2
No Assignees jabber.developer
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: devs/cproof#34
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?