File 2691-wx-Document-wx-subscribe_events-0.patch of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2691-wx-Document-wx-subscribe_events-0.patch of Package erlang (Revision b8a244adcb499cf00d0081173f870146)

Currently displaying revision b8a244adcb499cf00d0081173f870146 , Show latest

From 2c2fb8a690b37410edf47eb75bb16e0481cab899 Mon Sep 17 00:00:00 2001
From: Wojtek Mach <wojtek@wojtekmach.pl>
Date: Tue, 19 Apr 2022 23:27:56 +0200
Subject: [PATCH] wx: Document `wx:subscribe_events/0`

---
 lib/wx/doc/src/wx.xml | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/lib/wx/doc/src/wx.xml b/lib/wx/doc/src/wx.xml
index 982343cda4..a405b0a274 100644
--- a/lib/wx/doc/src/wx.xml
+++ b/lib/wx/doc/src/wx.xml
@@ -141,6 +141,47 @@ wxGBPosition={r,c},wxGBSpan={rs,cs},wxGridCellCoords={r,c}.
 another process wx environment.
 </desc></func>
 <func>
+<name since="">subscribe_events() -&gt; ok</name>
+<fsummary>Adds the calling process to the list of of processes that are
+listening to wx application events.</fsummary>
+
+<desc><marker id="subscribe_events-0"/>
+
+ Adds the calling process to the list of of processes that are listening to
+ wx application events.
+
+
+
+ At the moment these are all MacOSX specific events corresponding to
+ <c>MacNewFile()</c>
+ and friends from wxWidgets
+ <url href="https://docs.wxwidgets.org/trunk/classwx_app.html">wxApp</url>:
+
+
+<list>
+ <item>
+ <c>{new_file, ""}</c>
+ </item>
+ <item>
+ <c>{open_file, Filename}</c>
+ </item>
+ <item>
+ <c>{print_file, Filename}</c>
+ </item>
+ <item>
+ <c>{open_url, Url}</c>
+ </item>
+ <item>
+ <c>{reopen_app, ""}</c>
+ </item>
+</list>
+
+
+ The call always returns ok but will have sent any already received
+ events to the calling process.
+
+</desc></func>
+<func>
 <name since="">null() -&gt; <seeerl marker="#type-wx_object">wx_object()</seeerl></name>
 <fsummary>Returns the null object.</fsummary>
 
@@ -287,4 +328,4 @@ library.
 
 <authors>
 <aname> </aname>
-<email> </email></authors></erlref>
\ No newline at end of file
+<email> </email></authors></erlref>
-- 
2.34.1

Places

File 2691-wx-Document-wx-subscribe_events-0.patch of Package erlang (Revision b8a244adcb499cf00d0081173f870146)

Places