Files
Debian-9-Kernel/.metadata/.plugins/org.eclipse.linuxtools.cdt.libhover/C/devhelp.libhover
T

3128 lines
71 KiB
Plaintext
Raw Normal View History

2023-12-14 15:23:35 +01:00
¬ísr0org.eclipse.linuxtools.cdt.libhover.LibHoverInfoLclassestLjava/util/HashMap;L functionstLjava/util/TreeMap;Ltypedefsq~xpsrjava.util.HashMapÚÁÃF
loadFactorI thresholdxp?@wxsrjava.util.TreeMap Áö>-%jæL
comparatortLjava/util/Comparator;xppwjtlibxfce4ui_check_versionsr0org.eclipse.linuxtools.cdt.libhover.FunctionInfoLdesctLjava/lang/String;LheaderstLjava/util/ArrayList;Lnameq~ L prototypeq~ L
returnTypeq~ xpt\
<p>Checks that the libxfce4ui library
in use is compatible with the given version. Generally you would pass in
the constants LIBXFCE4UI_MAJOR_VERSION, LIBXFCE4UI_MINOR_VERSION and
LIBXFCE4UI_MICRO_VERSION as the three arguments to this function; that produces
a check that the library in use is compatible with the version of</p>
libxfce4ui the extension was
<p>compiled against.</p>
<p>Example 1. Checking the runtime version of the Libxfce4ui library</p>
<dl>
<dt>const gchar *mismatch;
mismatch = libxfce4ui_check_version (LIBXFCE4UI_MAJOR_VERSION,
LIBXFCE4UI_MINOR_VERSION,
LIBXFCE4UI_MICRO_VERSION);
if (G_UNLIKELY (mismatch != NULL))
g_error ("Version mismatch: %s", mismatch);</dt>
</dl>
<br><br>Parameters</br></br>
<dl>
<dt><p>required_major</p></dt>
<dd><p>the required major version.</p></dd>
<dd> </dd>
<dt><p>required_minor</p></dt>
<dd><p>the required minor version.</p></dd>
<dd> </dd>
<dt><p>required_micro</p></dt>
<dd><p>the required micro version.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> NULL if the library is compatible with the given version,
or a string describing the version mismatch. The returned
string is owned by the library and must not be freed or
modified by the caller.</p>
srjava.util.ArrayListxÒ™ÇaIsizexpwxq~ t< guintrequired_major,guintrequired_minor,guintrequired_microtconstttumbler_cache_cleanupsq~
t
sq~wxq~t< TumblerCache*cache,constgchar*const *base_uris,guint64sincetvoidttumbler_cache_copysq~
t
sq~wxq~tI TumblerCache*cache,constgchar*const *from_uris,constgchar*const *to_uristvoidttumbler_cache_deletesq~
t
sq~wxq~t* TumblerCache*cache,constgchar*const *uristvoidttumbler_cache_get_defaultsq~
t
sq~wxq~%t voidt TumblerCachettumbler_cache_get_flavorsq~
t
sq~wxq~+t# TumblerCache*cache,constgchar*nametTumblerThumbnailFlavorttumbler_cache_get_flavorssq~
t
sq~wxq~1t TumblerCache*cachetGListttumbler_cache_get_thumbnailsq~
t
sq~wxq~7t@ TumblerCache*cache,constgchar*uri,TumblerThumbnailFlavor*flavortTumblerThumbnailttumbler_cache_is_thumbnailsq~
t
sq~wxq~=t" TumblerCache*cache,constgchar*uritgbooleanttumbler_cache_movesq~
t
sq~wxq~CtI TumblerCache*cache,constgchar*const *from_uris,constgchar*const *to_uristvoidttumbler_check_versionsq~
t6
<p>Checks that the tumbler library
in use is compatible with the given version. Generally you would pass in
the constants TUMBLER_MAJOR_VERSION, TUMBLER_MINOR_VERSION and
TUMBLER_MICRO_VERSION as the three arguments to this function; that
produces a check that the library in use is compatible with the version
of tumbler the application was
compiled against.</p>
<p>Example 1. Checking the runtime version of the tumbler library</p>
<dl>
<dt>const gchar *mismatch;
mismatch = tumbler_check_version (TUMBLER_VERSION_MAJOR,
TUMBLER_VERSION_MINOR,
TUMBLER_VERSION_MICRO);
if (G_UNLIKELY (mismatch != NULL))
g_error ("Version mismatch: %s", mismatch);</dt>
</dl>
<br><br>Parameters</br></br>
<dl>
<dt><p>required_major</p></dt>
<dd><p>the required major version.</p></dd>
<dd> </dd>
<dt><p>required_minor</p></dt>
<dd><p>the required minor version.</p></dd>
<dd> </dd>
<dt><p>required_micro</p></dt>
<dd><p>the required micro version.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> NULL if the library is compatible with the given version,
or a string describing the version mismatch. The returned
string is owned by the library and must not be freed or
modified by the caller.</p>
sq~wxq~It< guintrequired_major,guintrequired_minor,guintrequired_microtconstttumbler_file_info_array_copysq~
t
sq~wxq~Ot# TumblerFileInfo**infos,guintlengthtTumblerFileInfottumbler_file_info_array_freesq~
t
sq~wxq~Ut TumblerFileInfo**infostvoidt'tumbler_file_info_array_new_with_flavorsq~
t
sq~wxq~[t_ constgchar*const *uris,constgchar*const *mime_types,TumblerThumbnailFlavor*flavor,guint*lengthtTumblerFileInfottumbler_file_info_get_mime_typesq~
t
sq~wxq~at TumblerFileInfo*infotconstttumbler_file_info_get_mtimesq~
t
sq~wxq~gt TumblerFileInfo*infotguint64ttumbler_file_info_get_thumbnailsq~
t
sq~wxq~mt TumblerFileInfo*infotTumblerThumbnailttumbler_file_info_get_urisq~
t
sq~wxq~st TumblerFileInfo*infotconstttumbler_file_info_loadsq~
t
sq~wxq~yt< TumblerFileInfo*info,GCancellable*cancellable,GError**errortgbooleanttumbler_file_info_needs_updatesq~
t
sq~wxq~t TumblerFileInfo*infotgbooleanttumbler_file_info_newsq~
t
sq~wxq~…tB constgchar*uri,constgchar*mime_type,TumblerThumbnailFlavor*flavortTumblerFileInfot$tumbler_provider_factory_get_defaultsq~
t
sq~wxq~t voidtTumblerProviderFactoryt&tumbler_provider_factory_get_providerssq~
t
sq~wxq~t) TumblerProviderFactory*factory,GTypetypetGListt!tumbler_provider_plugin_get_typessq~
t
sq~wxq~—tA constTumblerProviderPlugin*plugin,constGType**types,gint*n_typestvoidttumbler_provider_plugin_newsq~
t
sq~wxq~t constgchar*filenametTumblerProviderPluginttumbler_thumbnail_get_flavorsq~
t
sq~wxq~£t TumblerThumbnail*thumbnailtTumblerThumbnailFlavorttumbler_thumbnail_loadsq~
t
sq~wxq~©tB TumblerThumbnail*thumbnail,GCancellable*cancellable,GError**errortgbooleanttumbler_thumbnail_needs_updatesq~
t
sq~wxq~¯t7 TumblerThumbnail*thumbnail,constgchar*uri,guint64mtimetgbooleanttumbler_thumbnail_save_filesq~
t
sq~wxq~µtZ TumblerThumbnail*thumbnail,GFile*file,guint64mtime,GCancellable*cancellable,GError**errortgbooleant!tumbler_thumbnail_save_image_datasq~
t
sq~wxq~»te TumblerThumbnail*thumbnail,TumblerImageData*data,guint64mtime,GCancellable*cancellable,GError**errortgbooleant-tumbler_thumbnailer_provider_get_thumbnailerssq~
t
sq~wxq~Át$ TumblerThumbnailerProvider*providertGListtxfce_dialog_confirmsq~
t2
<p>Runs a questions dialog that has a 'Cancel' and a 'Confirm' button. The 'Confirm'
button text can be set by action
if given.</p>
<p>If stock_id
is equal to GTK_STOCK_YES, the 'Cancel' button becomes a 'No' button.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>stock_id</p></dt>
<dd><p>the stock name of the confirm button, for example GTK_STOCK_YES or GTK_STOCK_CLEAR.</p></dd>
<dd> </dd>
<dt><p>confirm_label</p></dt>
<dd><p>if non-NULL, this text is used on the confirm button together with the stock_id
icon. </p></dd>
<dd>[allow-none]</dd>
<dt><p>secondary_text</p></dt>
<dd><p>secondary text in the dialog. </p></dd>
<dd>[allow-none]</dd>
<dt><p>primary_format</p></dt>
<dd><p>the printf()-style format for the dialog question. </p></dd>
<dd>[allow-none]</dd>
<dt><p>...</p></dt>
<dd><p>argument list for the primary_format
. </p></dd>
<dd>[allow-none]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if the user confirms, else FALSE.</p>
sq~wxq~Çtv GtkWindow*parent,constgchar*stock_id,constgchar*confirm_label,constgchar*secondary_text,constgchar*primary_format,...tgbooleantxfce_dialog_confirm_close_tabssq~
tÂ
<p>Runs a dialog to ask the user whether they want to close the whole window,
close the current tab, or cancel.</p>
<p>If num_tabs
is non-negative, the message to the user will state that there
are num_tabs
open tabs. If num_tabs
is negative, then the message to the
user will state simply that there are "multiple open tabs".</p>
<p>If show_confirm_box
is TRUE a checkbox is added to the dialog to allow
the user to set whether they wish to see this dialog in future. The initial
state of the checkbox is determined by the value stored at confirm_box_checked
and the value at confirm_box_checked
after returning records the state of the
checkbox. If show_confirm_box
is FALSE, confirm_box_checked
is ignored and
may be NULL.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>num_tabs</p></dt>
<dd><p>the number of open tabs for display to user</p></dd>
<dd> </dd>
<dt><p>show_confirm_box</p></dt>
<dd><p>whether to ask the user if this confirmation shall be shown in the future</p></dd>
<dd> </dd>
<dt><p>confirm_box_checked</p></dt>
<dd><p>state of confirmation checkbox. </p></dd>
<dd>[allow-none]</dd>
</dl>
<br><br>Returns</br></br>
<p> GTK_RESPONSE_CANCEL if cancelled, GTK_RESPONSE_YES if the user
wants to close the window, GTK_RESPONSE_CLOSE if the user wants to close the tab,
and GTK_RESPONSE_NONE for an error.</p>
<p>Since: 4.16</p>
sq~wxq~ÍtT GtkWindow*parent,gintnum_tabs,gbooleanshow_confirm_box,gboolean*confirm_box_checkedtginttxfce_dialog_show_errorsq~
tŠ
<p>Displays an error dialog on parent
using the primary_format
as primary message and optionally
displaying error
as secondary error text.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>error</p></dt>
<dd><p>a GError, which gives a more precise description of the problem or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>primary_format</p></dt>
<dd><p>the printf()-style format for the primary problem description.</p></dd>
<dd> </dd>
<dt><p>...</p></dt>
<dd><p>argument list for the primary_format
.</p></dd>
<dd> </dd>
</dl>
sq~wxq~ÓtA GtkWindow*parent,constGError*error,constgchar*primary_format,...tvoidtxfce_dialog_show_helpsq~
t¨
<p>Asks the user to visit the online documentation. If confirmed, it will open
the webbrowser and redirect the user to the correct location.</p>
<p>Appart from the component
, page
and offset
the following information
is also send to the server: user language and the xfce_version_string().</p>
<p>See also: xfce_dialog_show_help_with_version().</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>component</p></dt>
<dd><p>name of the component opening the help page or NULL. If the
value is NULL the target will be the main page of the
documentation website. </p></dd>
<dd>[allow-none]</dd>
<dt><p>page</p></dt>
<dd><p>subpage of the component
on the website or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>offset</p></dt>
<dd><p>anchor offset in page
or NULL. </p></dd>
<dd>[allow-none]</dd>
</dl>
<p>Since: 4.10</p>
sq~wxq~ÙtH GtkWindow*parent,constgchar*component,constgchar*page,constgchar*offsettvoidt"xfce_dialog_show_help_with_versionsq~
t)
<p>Asks the user to visit the online documentation. If confirmed, it will open
the webbrowser and redirect the user to the correct location.</p>
<p>Apart from the component
, page
and offset
the following information
is also sent to the server: user language and the xfce_version_string()
or version
if set.</p>
<p>See also: xfce_dialog_show_help().</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>component</p></dt>
<dd><p>name of the component opening the help page or NULL. If the
value is NULL the target will be the main page of the
documentation website. </p></dd>
<dd>[allow-none]</dd>
<dt><p>page</p></dt>
<dd><p>subpage of the component
on the website or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>offset</p></dt>
<dd><p>anchor offset in page
or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>version</p></dt>
<dd><p>alternative version, or NULL to use xfce_version_string(). </p></dd>
<dd>[allow-none]</dd>
</dl>
<p>Since: 4.12</p>
sq~wxq~ßt[ GtkWindow*parent,constgchar*component,constgchar*page,constgchar*offset,constgchar*versiontvoidtxfce_dialog_show_infosq~
t-
<p>Displays an information dialog on parent
using the primary_format
as message.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>secondary_text</p></dt>
<dd><p>secondary text of the dialog or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>primary_format</p></dt>
<dd><p>the printf()-style format for the primary problem description.</p></dd>
<dd> </dd>
<dt><p>...</p></dt>
<dd><p>argument list for the format
.</p></dd>
<dd> </dd>
</dl>
sq~wxq~åtI GtkWindow*parent,constgchar*secondary_text,constgchar*primary_format,...tvoidtxfce_dialog_show_warningsq~
t(
<p>Displays a warning dialog on parent
using the primary_format
as message.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>secondary_text</p></dt>
<dd><p>secondary text of the dialog or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>primary_format</p></dt>
<dd><p>the printf()-style format for the primary problem description.</p></dd>
<dd> </dd>
<dt><p>...</p></dt>
<dd><p>argument list for the format
.</p></dd>
<dd> </dd>
</dl>
sq~wxq~ëtI GtkWindow*parent,constgchar*secondary_text,constgchar*primary_format,...tvoidtxfce_filename_input_checksq~
tà
<p>Forces a check of the current input text even when it has not changed.
This is useful to force the appropriate signal to be sent to indicate
whether the text is a valid filename or not, so that for example any
GtkWidgets whose sensitivity is controlled by this can be correctly updated
when they are first created.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>filename_input</p></dt>
<dd><p>a XfceFilenameInput instance.</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~ñt! XfceFilenameInput*filename_inputtvoidt&xfce_filename_input_desensitise_widgetsq~
tŽ
<p>A convenience function to be connected as a callback for the "text-invalid" signal
(for example, using g_connect_swapped) for the simple case where the desired effect
of this signal is to set the sensitivity of a single GtkWidget (for example, a GtkButton).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>widget</p></dt>
<dd><p>a GtkWidget</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~÷t GtkWidget*widgettvoidtxfce_filename_input_get_entrysq~
t
<p>Gets the GtkEntry associated to filename_input</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>filename_input</p></dt>
<dd><p>a XfceFilenameInput instance.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A GtkEntry. </p>
<p>[transfer none]</p>
<p>Since: 4.16</p>
sq~wxq~ýt! XfceFilenameInput*filename_inputtGtkEntrytxfce_filename_input_get_textsq~
t/
<p>Gets the current text of the widget.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>filename_input</p></dt>
<dd><p>a XfceFilenameInput instance.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>the string representing the current text. </p>
<p>[transfer none]</p>
<p>Since: 4.16</p>
sq~wxq~t! XfceFilenameInput*filename_inputtconstt$xfce_filename_input_sensitise_widgetsq~
tŒ
<p>A convenience function to be connected as a callback for the "text-valid" signal
(for example, using g_connect_swapped) for the simple case where the desired effect
of this signal is to set the sensitivity of a single GtkWidget (for example, a GtkButton).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>widget</p></dt>
<dd><p>a GtkWidget</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~ t GtkWidget*widgettvoidtxfce_gdk_screen_get_activesq~
tÞ
<p>Returns the currently active GdkScreen, that is, the screen which
currently contains the pointer. If no active screen was found, the
default GdkScreen is returned.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>monitor_return</p></dt>
<dd><p>Address to store the monitor number to or NULL.
Under gtk3 this will always be set to '0'. </p></dd>
<dd>[out][allow-none]</dd>
</dl>
<br><br>Returns</br></br>
<p>the currently active GdkScreen. </p>
<p>[transfer full]</p>
sq~wxq~t gint*monitor_returnt GdkScreentxfce_gdk_screen_get_geometrysq~
t
<p>Returns the width and height of the default GdkScreen.
This is a replacement for gdk_screen_width/gdk_screen_height.</p>
<br><br>Returns</br></br>
<p>a newly created GdkRectangle
containing the width and height of the screen. </p>
<p>[transfer full]</p>
<p>Since: 4.14</p>
sq~wxq~t voidt GdkRectangletxfce_gicon_from_namesq~
t
<p>This function will first look for a desktop file of name
and if successful
use the value of the "Icon" property to return a GIcon.
If no desktop file of name
is found it will fallback to returning a GIcon
based on g_themed_icon_new_with_default_fallbacks and
gtk_icon_theme_lookup_by_gicon.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>name</p></dt>
<dd><p>Name of the application.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>a new GThemedIcon. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~t constgchar*nametGIcont+xfce_gtk_accel_group_connect_action_entriessq~
tž
<p>This method will connect each accel_path from the XfceGtkActionEntry in action_entries
to its related callback. If the accelerator is pressed, the related callback will be called.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>accel_group</p></dt>
<dd><p>the GtkAccelGroup to connect to</p></dd>
<dd> </dd>
<dt><p>action_entries</p></dt>
<dd><p>array of action_entries to be added</p></dd>
<dd> </dd>
<dt><p>n_action_entries</p></dt>
<dd><p>size of the action_entries array</p></dd>
<dd> </dd>
<dt><p>callback_data</p></dt>
<dd><p>data which should be passed to the callback of each XfceGtkActionEntry</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~!tm GtkAccelGroup*accel_group,constXfceGtkActionEntry*action_entries,guintn_action_entries,gpointercallback_datatvoidt.xfce_gtk_accel_group_disconnect_action_entriessq~
tÂ
<p>This method will disconnect each accel_path from the XfceGtkActionEntry in action_entries.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>accel_group</p></dt>
<dd><p>the GtkAccelGroup to connect to</p></dd>
<dd> </dd>
<dt><p>action_entries</p></dt>
<dd><p>array of action_entries to be added</p></dd>
<dd> </dd>
<dt><p>n_action_entries</p></dt>
<dd><p>size of the action_entries array</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~'tW GtkAccelGroup*accel_group,constXfceGtkActionEntry*action_entries,guintn_action_entriestvoidtxfce_gtk_accel_map_add_entriessq~
t
<p>Adds the default key of each ActionEntry to the accel_map, if no key was defined for the related accel_path so far.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>action_entries</p></dt>
<dd><p>array of action_entries to be added</p></dd>
<dd> </dd>
<dt><p>n_action_entries</p></dt>
<dd><p>size of the action_entries array</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~-t= constXfceGtkActionEntry*action_entries,guintn_action_entriestvoidtxfce_gtk_button_new_mixedsq~
t²
<p>Creates a new GtkButton containing a mnemonic label and a stock icon.
The stock_id
could be something like GTK_STOCK_OK or GTK_STOCK_APPLY.</p>
<p>When the stock_id
is NULL a normal mnemonic button will be created,
when label
is NULL a stock button will be created. This behaviour
is added for xfce_message_dialog_new().</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>stock_id</p></dt>
<dd><p>the name of the stock item.</p></dd>
<dd> </dd>
<dt><p>label</p></dt>
<dd><p>the text of the button, with an underscore in front of
the mnemonic character.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>the newly created GtkButton widget. </p>
<p>[transfer full]</p>
sq~wxq~3t% constgchar*stock_id,constgchar*labelt GtkWidgettxfce_gtk_check_menu_item_newsq~
t
<p>Convenience method to create a GtkCheckMenuItem and preconfigure it with the passed parameters.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label_text</p></dt>
<dd><p>Label to use for the GtkCheckMenuItem</p></dd>
<dd> </dd>
<dt><p>tooltip_text</p></dt>
<dd><p>Tooltip to add on the passed item, or NULL</p></dd>
<dd> </dd>
<dt><p>accel_path</p></dt>
<dd><p>Unique path, used to identify the accelerator, or NULL</p></dd>
<dd> </dd>
<dt><p>callback</p></dt>
<dd><p>GCallback which will be triggered on activation, or NULL. </p></dd>
<dd>[scope notified]</dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>active</p></dt>
<dd><p>boolean value indicating whether the check box is active.</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkCheckMenuItem. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~9t constgchar*label_text,constgchar*tooltip_text,constgchar*accel_path,GCallbackcallback,GObject*callback_param,gbooleanactive,GtkMenuShell*menu_to_append_itemt GtkWidgettxfce_gtk_frame_box_newsq~
tÐ
<p>Creates an Xfce-styled frame. The frame is a GtkFrame, without
outline and an optional bolded text label. The contents of the
frame are indented on the left.
The return value is the GtkFrame itself. The container_return
is
a GtkAlignment widget to which children of the frame should be added.</p>
<p>See also: xfce_gtk_frame_box_new_with_content().</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label</p></dt>
<dd><p>the text to use as the label of the frame.</p></dd>
<dd> </dd>
<dt><p>container_return</p></dt>
<dd><p>return location for the frame's container. </p></dd>
<dd>[out][allow-none]</dd>
</dl>
<br><br>Returns</br></br>
<p>the newly created GtkFrame widget. </p>
<p>[transfer full]</p>
sq~wxq~?t- constgchar*label,GtkWidget**container_returnt GtkWidgett#xfce_gtk_frame_box_new_with_contentsq~
t°
<p>Creates a widget with xfce_gtk_frame_box_new() and adds the
content
GtkWidget to the frame.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label</p></dt>
<dd><p>the text to use as the label of the frame.</p></dd>
<dd> </dd>
<dt><p>content</p></dt>
<dd><p>the GtkWidget to put inside the frame.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>the newly created GtkFrame widget. </p>
<p>[transfer full]</p>
sq~wxq~Et# constgchar*label,GtkWidget*contentt GtkWidgettxfce_gtk_get_action_entry_by_idsq~
t;
<p>Convenience method to find a specific action_entry from an array of action_entries</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>action_entries</p></dt>
<dd><p>array of action_entries to be searched</p></dd>
<dd> </dd>
<dt><p>n_action_entries</p></dt>
<dd><p>size of the action_entries array</p></dd>
<dd> </dd>
<dt><p>id</p></dt>
<dd><p>id of the action entry (usually enum values are used)</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>The matching XfceGtkActionEntry or NULL if not found. </p>
<p>[transfer none]</p>
<p>Since: 4.16</p>
sq~wxq~KtE constXfceGtkActionEntry*action_entries,guintn_action_entries,guintidtconsttxfce_gtk_image_menu_item_newsq~
tn
<p>Convenience method to create a deprecated GtkImageMenuItem and preconfigure it with the passed parameters.
In order to prevent G_GNUC_BEGIN_IGNORE_DEPRECATIONS in all xfce projects, this method can be used</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label_text</p></dt>
<dd><p>Label to use for the GtkImageMenuItem</p></dd>
<dd> </dd>
<dt><p>tooltip_text</p></dt>
<dd><p>Tooltip to add on the passed item, or NULL</p></dd>
<dd> </dd>
<dt><p>accel_path</p></dt>
<dd><p>Unique path, used to identify the accelerator, or NULL</p></dd>
<dd> </dd>
<dt><p>callback</p></dt>
<dd><p>GCallback which will be triggered on activation, or NULL. </p></dd>
<dd>[scope notified]</dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>image</p></dt>
<dd><p>a widget to set as the image for the menu item, or NULL</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkImageMenuItem. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~Qtž constgchar*label_text,constgchar*tooltip_text,constgchar*accel_path,GCallbackcallback,GObject*callback_param,GtkWidget*image,GtkMenuShell*menu_to_append_itemt GtkWidgett+xfce_gtk_image_menu_item_new_from_icon_namesq~
t
<p>Convenience method to create a GtkImageMenuItem and preconfigure it with the passed parameters.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label_text</p></dt>
<dd><p>Label to use for the GtkImageMenuItem</p></dd>
<dd> </dd>
<dt><p>tooltip_text</p></dt>
<dd><p>Tooltip to add on the passed item, or NULL</p></dd>
<dd> </dd>
<dt><p>accel_path</p></dt>
<dd><p>Unique path, used to identify the accelerator, or NULL</p></dd>
<dd> </dd>
<dt><p>callback</p></dt>
<dd><p>GCallback which will be triggered on activation, or NULL. </p></dd>
<dd>[scope notified]</dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>icon_name</p></dt>
<dd><p>name of the icon to use for the GtkImageMenuItem, or NULL</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkImageMenuItem. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~Wt£ constgchar*label_text,constgchar*tooltip_text,constgchar*accel_path,GCallbackcallback,GObject*callback_param,constgchar*icon_name,GtkMenuShell*menu_to_append_itemt GtkWidgettxfce_gtk_menu_append_seperatorsq~
tû
<p>Convenience method do add separators, used to prevent code duplication</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>menu</p></dt>
<dd><p>GtkMenuShell on which the separator should be appended</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~]t GtkMenuShell*menutvoidtxfce_gtk_menu_item_newsq~
t
<p>Convenience method to create a GtkMenuItem and preconfigure it with the passed parameters.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label_text</p></dt>
<dd><p>Label to use for the GtkMenuItem</p></dd>
<dd> </dd>
<dt><p>tooltip_text</p></dt>
<dd><p>Tooltip to add on the passed item, or NULL</p></dd>
<dd> </dd>
<dt><p>accel_path</p></dt>
<dd><p>Unique path, used to identify the accelerator, or NULL</p></dd>
<dd> </dd>
<dt><p>callback</p></dt>
<dd><p>GCallback which will be triggered on activation, or NULL. </p></dd>
<dd>[scope notified]</dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkMenuItem. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~ctŽ constgchar*label_text,constgchar*tooltip_text,constgchar*accel_path,GCallbackcallback,GObject*callback_param,GtkMenuShell*menu_to_append_itemt GtkWidgett(xfce_gtk_menu_item_new_from_action_entrysq~
t
<p>Method to create a menu item from the passed action entry</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>action_entry</p></dt>
<dd><p>Label to use for the GtkCheckMenuItem</p></dd>
<dd> </dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkMenuItem or NULL. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~it] constXfceGtkActionEntry*action_entry,GObject*callback_param,GtkMenuShell*menu_to_append_itemt GtkWidgett"xfce_gtk_menu_item_set_accel_labelsq~
t
<p>Use the passed accel_path show the related GtkAccelLabel with the correct accelerator on the item.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>menu_item</p></dt>
<dd><p>GtkMenuItem on which the accel label is to set</p></dd>
<dd> </dd>
<dt><p>accel_path</p></dt>
<dd><p>Unique path, used to identify the accelerator, or NULL to show no accelerator</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~ot, GtkMenuItem*menu_item,constgchar*accel_pathtvoidt xfce_gtk_menu_popup_until_mappedsq~
t¹
<p>Attempts to pop up a GtkMenu for a short duration. Unlike the original
gtk_menu_popup(), this function will verify that the menu has been mapped
or will keep trying for up to 250ms. It will also return a value indicating
whether the menu was eventually mapped or not. Following is an excerpt from
the GTK+ Documentation on GtkMenu.</p>
<p>Displays a menu and makes it available for selection.</p>
<p>Applications can use this function to display context-sensitive menus, and will
typically supply NULL for the parent_menu_shell
, parent_menu_item
, func
and
data
parameters. The default menu positioning function will position the menu
at the current mouse cursor position.</p>
<p>The button
parameter should be the mouse button pressed to initiate the menu
popup. If the menu popup was initiated by something other than a mouse button
press, such as a mouse button release or a keypress, button should be 0.</p>
<p>The activate_time
parameter is used to conflict-resolve initiation of concurrent
requests for mouse/keyboard grab requests. To function properly, this needs to
be the timestamp of the user event (such as a mouse click or key press) that
caused the initiation of the popup. Only if no such event is available,
gtk_get_current_event_time() can be used instead.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>menu</p></dt>
<dd><p>a GtkMenu.</p></dd>
<dd> </dd>
<dt><p>parent_menu_shell</p></dt>
<dd><p>the menu shell containing the triggering menu item, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>parent_menu_item</p></dt>
<dd><p>the menu item whose activation triggered the popup, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>func</p></dt>
<dd><p>a user supplied function used to position the menu, or NULL. </p></dd>
<dd>[scope call][allow-none]</dd>
<dt><p>data</p></dt>
<dd><p>user supplied data to be passed to func. </p></dd>
<dd>[allow-none]</dd>
<dt><p>button</p></dt>
<dd><p>the mouse button which was pressed to initiate the event.</p></dd>
<dd> </dd>
<dt><p>activate_time</p></dt>
<dd><p>the time at which the activation event occurred.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if the menu could be mapped, FALSE otherwise.</p>
<p>Since: 4.14</p>
sq~wxq~utŠ GtkMenu*menu,GtkWidget*parent_menu_shell,GtkWidget*parent_menu_item,GtkMenuPositionFuncfunc,gpointerdata,guintbutton,guint32activate_timetgbooleantxfce_gtk_radio_menu_item_newsq~
tU
<p>Convenience method to create a GtkCheckMenuItem and preconfigure it with the passed parameters.
In order to simplify usage, a GtkCheckMenuItem is created and drawn as radio-item</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>label_text</p></dt>
<dd><p>Label to use for the GtkCheckMenuItem</p></dd>
<dd> </dd>
<dt><p>tooltip_text</p></dt>
<dd><p>Tooltip to add on the passed item, or NULL</p></dd>
<dd> </dd>
<dt><p>accel_path</p></dt>
<dd><p>Unique path, used to identify the accelerator, or NULL</p></dd>
<dd> </dd>
<dt><p>callback</p></dt>
<dd><p>GCallback which will be triggered on activation, or NULL. </p></dd>
<dd>[scope notified]</dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>active</p></dt>
<dd><p>boolean value indicating whether the check box is active.</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkCheckMenuItem. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~{t constgchar*label_text,constgchar*tooltip_text,constgchar*accel_path,GCallbackcallback,GObject*callback_param,gbooleanactive,GtkMenuShell*menu_to_append_itemt GtkWidgett/xfce_gtk_toggle_menu_item_new_from_action_entrysq~
t
<p>Method to create a toggle menu item from the passed action entry</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>action_entry</p></dt>
<dd><p>Label to use for the GtkCheckMenuItem</p></dd>
<dd> </dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>active</p></dt>
<dd><p>boolean value indicating whether the check box is active.</p></dd>
<dd> </dd>
<dt><p>menu_to_append_item</p></dt>
<dd><p>GtkMenuShell on which the item should be appended, or NULL</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkMenuItem or NULL. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~tl constXfceGtkActionEntry*action_entry,GObject*callback_param,gbooleanactive,GtkMenuShell*menu_to_append_itemt GtkWidgett*xfce_gtk_tool_button_new_from_action_entrysq~
t
<p>Method to create a toolbar button from the passed action entry</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>action_entry</p></dt>
<dd><p>Label to use for the GtkTolButton</p></dd>
<dd> </dd>
<dt><p>callback_param</p></dt>
<dd><p>optional callback parameter, or NULL.</p></dd>
<dd> </dd>
<dt><p>toolbar_to_append_item</p></dt>
<dd><p>GtkToolBar on which the item should be appended</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkTolButton. </p>
<p>[transfer full]</p>
<p>Since: 4.16</p>
sq~wxq~‡t^ constXfceGtkActionEntry*action_entry,GObject*callback_param,GtkToolbar*toolbar_to_append_itemt GtkWidgett!xfce_gtk_translate_action_entriessq~
tp
<p>Convenience method to translate the label text and tooltip text of an array of action_entries</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>action_entries</p></dt>
<dd><p>array of action_entries to be translated</p></dd>
<dd> </dd>
<dt><p>n_action_entries</p></dt>
<dd><p>size of the action_entries array</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~t8 XfceGtkActionEntry*action_entries,guintn_action_entriestvoidt'xfce_gtk_window_center_on_active_screensq~
tÿ
<p>Determines the screen that contains the pointer and centers the
window
on it. If it failes to determine the current pointer position,
window
is centered on the default screen.</p>
<p>This function only works properly if you call it before realizing the
window and you haven't set a fixed window position using gtk_window_move().</p>
<p>See also: xfce_gdk_screen_get_active().</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>window</p></dt>
<dd><p>the GtkWindow to center.</p></dd>
<dd> </dd>
</dl>
sq~wxq~“t GtkWindow*windowtvoidtxfce_has_gtk_frame_extentssq~
t
<p>This function can be called to determine if a GdkWindow is using client-side decorations
which is indicated by the _GTK_FRAME_EXTENTS X11 atom. It furthermore sets a pointer
of type GtkBorder to the actual extents.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>window</p></dt>
<dd><p>A GdkWindow</p></dd>
<dd> </dd>
<dt><p>extents</p></dt>
<dd><p>A pointer to a GtkBorder to copy to.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if a GdkWindow has the _GTK_FRAME_EXTENTS atom set.</p>
<p>Since: 4.16</p>
sq~wxq~™t# GdkWindow*window,GtkBorder*extentstgbooleantxfce_icon_name_from_desktop_idsq~
t÷
<br><br>Parameters</br></br>
<dl>
<dt><p>desktop_id</p></dt>
<dd><p>Name of the desktop file.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> NULL on error, else the string value of the "Icon" property.</p>
<p>Since: 4.16</p>
sq~wxq~Ÿt constgchar*desktop_idtgchartxfce_message_dialogsq~
tÚ
<p>Create a new dialog as in xfce_message_dialog_new(), then runs the
dialog using gtk_dialog_run and return the response id selected by the user.</p>
<p>See xfce_message_dialog_new() for more information.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>title</p></dt>
<dd><p>title of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>stock_id</p></dt>
<dd><p>gtk stock icon name to show in the dialog.</p></dd>
<dd> </dd>
<dt><p>primary_text</p></dt>
<dd><p>primary text shown in large bold font.</p></dd>
<dd> </dd>
<dt><p>secondary_text</p></dt>
<dd><p>secondary text shown in normal font.</p></dd>
<dd> </dd>
<dt><p>first_button_text</p></dt>
<dd><p>text for the first button.</p></dd>
<dd> </dd>
<dt><p>...</p></dt>
<dd><p>NULL ended list of parameters.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> the selected response id.</p>
sq~wxq~¥t‰ GtkWindow*parent,constgchar*title,constgchar*stock_id,constgchar*primary_text,constgchar*secondary_text,constgchar*first_button_text,...tginttxfce_message_dialog_newsq~
t Ð
<p>xfce_message_dialog_new() allows you to easily create Gtk+ message dialogs.
It accepts GTK+ stock buttons (deprecated), mixed buttons (using XFCE_BUTTON_TYPE_MIXED)
or buttons with a GdkPixbuf (using XFCE_BUTTON_TYPE_PIXBUF).</p>
<p>The buttons are defined by first_button_text
and the next arguments in the
following format type
, param1
[, param2
, param3
].</p>
<dl>
<dt><p>XFCE_BUTTON_TYPE_MIXED</p></dt>
<dd><p>
This allows you to easily create mixed buttons in a dialog.
param1 is used for the icon name, param2 for the label and
param3 for the response_id. See also xfce_gtk_button_new_mixed().
</p></dd>
<dt><p>XFCE_BUTTON_TYPE_PIXBUF</p></dt>
<dd><p>
Creates a button with the GdkPixbuf as button icon.
param1 is the GdkPixbuf, param2 for the label and
param3 for the response_id.
</p></dd>
<dt><p>Stock Buttons</p></dt>
<dd><p>
When the variables above were not matched, the button type
will be a stock button. type will be the stock id, param1
is used for the response_id.
</p></dd>
</dl>
<p>To clarify this behaviour see the example below. We create a dialog with
two stock buttons, a GdkPixbuf button and a mixed button.</p>
<p>Example 3. Creating a Xfce Message Dialog</p>
<dl>
<dt>GdkPixbuf *pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 24, 24);
GtkWidget *dialog = xfce_message_dialog (parent, "Question",
GTK_STOCK_DIALOG_QUESTION,
"There are unsaved modifications",
"The menu has been modified, do you want to save it before quitting?",
GTK_STOCK_SAVE, GTK_RESPONSE_YES,
XFCE_BUTTON_TYPE_MIXED, "edit-delete", _("Forget modifications"), GTK_RESPONSE_APPLY,
XFCE_BUTTON_TYPE_PIXBUF, pixbuf, "Quit", GTK_RESPONSE_NO,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
NULL);
g_object_unref (G_OBJECT (pixbuf));</dt>
</dl>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>title</p></dt>
<dd><p>title of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>stock_id</p></dt>
<dd><p>gtk stock icon name to show in the dialog.</p></dd>
<dd> </dd>
<dt><p>primary_text</p></dt>
<dd><p>primary text shown in large bold font.</p></dd>
<dd> </dd>
<dt><p>secondary_text</p></dt>
<dd><p>secondary text shown in normal font.</p></dd>
<dd> </dd>
<dt><p>first_button_text</p></dt>
<dd><p>text for the first button.</p></dd>
<dd> </dd>
<dt><p>...</p></dt>
<dd><p>NULL terminated list of parameters.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkMessageDialog. </p>
<p>[transfer full]</p>
sq~wxq~«t‰ GtkWindow*parent,constgchar*title,constgchar*stock_id,constgchar*primary_text,constgchar*secondary_text,constgchar*first_button_text,...t GtkWidgettxfce_message_dialog_new_valistsq~
tt
<p>See xfce_message_dialog_new(), this version takes a va_list for
language bindings to use.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>parent</p></dt>
<dd><p>transient parent of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>title</p></dt>
<dd><p>title of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>icon_stock_id</p></dt>
<dd><p>gtk stock icon name to show in the dialog.</p></dd>
<dd> </dd>
<dt><p>primary_text</p></dt>
<dd><p>primary text shown in large bold font.</p></dd>
<dd> </dd>
<dt><p>secondary_text</p></dt>
<dd><p>secondary text shown in normal font.</p></dd>
<dd> </dd>
<dt><p>first_button_text</p></dt>
<dd><p>text for the first button.</p></dd>
<dd> </dd>
<dt><p>args</p></dt>
<dd><p>argument list.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new GtkMessageDialog. </p>
<p>[transfer full]</p>
sq~wxq~±t GtkWindow*parent,constgchar*title,constgchar*icon_stock_id,constgchar*primary_text,constgchar*secondary_text,constgchar*first_button_text,va_listargst GtkWidgettxfce_sm_client_connectsq~
t
<p>Attempts to connect to the session manager.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>error</p></dt>
<dd><p>A GError location. </p></dd>
<dd>[out][allow-none][transfer full]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE on success, FALSE otherwise. If an error
occurs, error
will be set.</p>
sq~wxq~·t% XfceSMClient*sm_client,GError**errortgbooleantxfce_sm_client_disconnectsq~
tJ
<p>Disconnects the application from the session manager.</p>
<p>
This may not remove the application from the saved
session (if any) if the user later does not choose to save
the session when logging out.
</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
sq~wxq~½t XfceSMClient*sm_clienttvoidtxfce_sm_client_getsq~
tÅ
<p>Gets the application's SM client instance. This is best
used with xfce_sm_client_get_option_group() above (and using
the returned GOptionGroup with g_option_context_parse()), as the
command line parsing will figure out many of the SM client's
required property values for you.</p>
<p>If you are not using Gtk or Glib's command-line option parser,
take a look at xfce_sm_client_new_with_argv() and
xfce_sm_client_new_full().</p>
<p>If you have already created an XfceSMClient instance using
this function or one of the xfce_sm_client_new_*() functions,
this will return the same instance.</p>
<p>[constructor]</p>
<br><br>Returns</br></br>
<p>A new or existing XfceSMClient. </p>
<p>[transfer full]</p>
sq~wxq~Ãt voidt XfceSMClienttxfce_sm_client_get_client_idsq~
t
<p>Retrieves the session client's unique ID. This ID can
be used to construct a filename used to restore the
application's state. Note that this value is only
guaranteed to be valid if connected to the session manager.</p>
<p>
Instead of constructing a state filename, it is
recommended to use xfce_sm_client_get_state_file().
</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> an opaque object-owned string</p>
sq~wxq~Ét XfceSMClient*sm_clienttconstt$xfce_sm_client_get_current_directorysq~
t.
<p>Retrieves the session client's working directory. See
xfce_sm_client_set_current_directory() for more information.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> an object-owned string</p>
sq~wxq~Ït XfceSMClient*sm_clienttconsttxfce_sm_client_get_fullsq~
tç
<p>Creates a new SM client instance, allowing the application
fine-grained control over the initial properties set.
Note that this function does not actually connect to the session
manager, so other actions can be taken (such as setting custom
properties or connecting signals) before calling
xfce_sm_client_connect().</p>
<p>It is recommended to use xfce_sm_client_get_with_argv(), or,
if you are using Gtk or Glib's command-line option parser,
xfce_sm_client_get_option_group() and xfce_sm_client_get() instead.</p>
<p>[constructor]</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>restart_style</p></dt>
<dd><p>An XfceSMClientRestartStyle</p></dd>
<dd> </dd>
<dt><p>priority</p></dt>
<dd><p>A restart priority</p></dd>
<dd> </dd>
<dt><p>resumed_client_id</p></dt>
<dd><p>The client id used in the previous session</p></dd>
<dd> </dd>
<dt><p>current_directory</p></dt>
<dd><p>The application's working directory</p></dd>
<dd> </dd>
<dt><p>restart_command</p></dt>
<dd><p>A command that can resume the application's
saved state</p></dd>
<dd> </dd>
<dt><p>desktop_file</p></dt>
<dd><p>The application's .desktop file</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new XfceSMClient instance. </p>
<p>[transfer full]</p>
sq~wxq~Õt£ XfceSMClientRestartStylerestart_style,gucharpriority,constgchar*resumed_client_id,constgchar*current_directory,constgchar**restart_command,constgchar*desktop_filet XfceSMClienttxfce_sm_client_get_option_groupsq~
tv
<p>Constructs a GOptionGroup suitable for use with Glib's
command-line option parser.</p>
<p>This function is a bit sneaky in that it will make a copy of
the program's argc and argv before GTK+ etc.
has a chance to mess around with it, so XfceSMClient can later
construct an accurate restart command. Instead of calling
gtk_init() or gtk_init_with_args(), instead you'd do something
like:</p>
<dl>
<dt>GOptionContext *context = g_option_context_new("");
g_option_context_add_group(context, gtk_get_option_group(TRUE));
g_option_context_add_group(context, xfce_sm_client_get_option_group(argc, argv);
g_option_context_parse(context, &argc, &argv, NULL);</dt>
</dl>
<p>Error checking is omitted here for brevity, and of course you could
add your app's own options with g_option_context_add_main_entries()
or similar.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>argc</p></dt>
<dd><p>The application's argument count</p></dd>
<dd> </dd>
<dt><p>argv</p></dt>
<dd><p>The application's argument vector</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> A new GOptionGroup</p>
sq~wxq~Ût gintargc,gchar**argvt GOptionGrouptxfce_sm_client_get_prioritysq~
t1
<p>Retrieves the session client's restart priority. See
xfce_sm_client_set_priority() for more information.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> a value from G_MININT8 to G_MAXINT8</p>
sq~wxq~át XfceSMClient*sm_clienttguint8t"xfce_sm_client_get_restart_commandsq~
t1
<p>Retrieves the session client's restart command. See
xfce_sm_client_set_restart_command() for more information.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> an object-owned string vector</p>
sq~wxq~çt XfceSMClient*sm_clienttconstt xfce_sm_client_get_restart_stylesq~
t>
<p>Retrieves the session client's restart style. See
xfce_sm_client_set_restart_style() for more information.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> a value from the XfceSMClientRestartStyle enum</p>
sq~wxq~ít XfceSMClient*sm_clienttXfceSMClientRestartStyletxfce_sm_client_get_state_filesq~
t
<p>Constructs a filename that can be used to restore or save
state information.</p>
<p>When saving state, ote that this file may already exist (and
may have been used for saving previous state for the
application), so the application should first remove or empty
the file if it requires a fresh state file.</p>
<p>On the next application start, this function can be used to
check to see if there is any previous saved state, and, if so,
the state can be restored from the file.</p>
<p>This function will use a standard location and naming scheme
and handle state cleanup (setting of the discard command) for you.</p>
<p>Before calling this function, the application must have a
valid program identifier set (see xfce_sm_client_set_program())
and a valid client ID (see xfce_sm_client_get_client_id()).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> a file name string, owned by the object or NULL if
the session client is disabled.</p>
sq~wxq~ót XfceSMClient*sm_clienttconsttxfce_sm_client_get_with_argvsq~
tÛ
<p>Creates a new XfceSMClient instance. It attempts to
set all required properties using the app's command line.
Note that this function does not actually connect to the session
manager, so other actions can be taken (such as setting custom
properties or connecting signals) before calling
xfce_sm_client_connect().</p>
<p>If you are using Gtk or Glib's command-line option parser,
it is recommended that you use xfce_sm_client_get_option_group()
and xfce_sm_client_get() instead.</p>
<p>[constructor]</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>argc</p></dt>
<dd><p>The number of arguments passed to main()</p></dd>
<dd> </dd>
<dt><p>argv</p></dt>
<dd><p>The argument vector passed to main()</p></dd>
<dd> </dd>
<dt><p>restart_style</p></dt>
<dd><p>An XfceSMClientRestartStyle</p></dd>
<dd> </dd>
<dt><p>priority</p></dt>
<dd><p>A restart priority</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>A new XfceSMClient instance. </p>
<p>[transfer full]</p>
sq~wxq~ùtJ gintargc,gchar**argv,XfceSMClientRestartStylerestart_style,gucharpriorityt XfceSMClienttxfce_sm_client_is_connectedsq~
t-
<p>Determines whether or not the application has connected to the
session manager.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if connected to the session manager, FALSE otherwise</p>
sq~wxq~ÿt XfceSMClient*sm_clienttgbooleantxfce_sm_client_is_resumedsq~
t
<p>Determines whether the application was resumed from a previous
session, or if the application has been started fresh with no
state information associated with it.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if resumed from a previous session, FALSE otherwise</p>
sq~wxq~t XfceSMClient*sm_clienttgbooleantxfce_sm_client_request_shutdownsq~
t5
<p>Sends a request to the session manager to end the session.
Depending on hint
, the session manager may prompt for a
certain action (log out, halt, reboot, etc.) or may take the
requested action without user intervention.</p>
<p>
The session manager may or may not support all requested
actions, and is also free to ignore the requested action.
</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>shutdown_hint</p></dt>
<dd><p>The type of shutdown requested</p></dd>
<dd> </dd>
</dl>
sq~wxq~ t= XfceSMClient*sm_client,XfceSMClientShutdownHintshutdown_hinttvoidt$xfce_sm_client_set_current_directorysq~
tM
<p>Sets the startup working directory of sm_client
to
current_directory
. If unset, defaults to the user's
home directory.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>current_directory</p></dt>
<dd><p>A valid path name</p></dd>
<dd> </dd>
</dl>
sq~wxq~t4 XfceSMClient*sm_client,constgchar*current_directorytvoidtxfce_sm_client_set_desktop_filesq~
t
<p>Sets the application's .desktop file. In addition to informing
the session manager of the .desktop file so it can present localized
names and an icon in session listings and the splash screen, this
also calls g_set_application_name() and
gtk_window_set_default_icon_name() (or
gtk_window_set_default_icon_from_file()) if the Name and Icon
keys are present, respectively.</p>
<p>If a relative path to the file is provided, this function will search
the standard application directories as specified by the</p>
XDG
Desktop Menu Specification.
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>desktop_file</p></dt>
<dd><p>The path to the application's .desktop file</p></dd>
<dd> </dd>
</dl>
sq~wxq~t/ XfceSMClient*sm_client,constgchar*desktop_filetvoidtxfce_sm_client_set_prioritysq~
t
<p>Sets the startup priority for sm_client
to priority
. Note
that the default priority for applications is 50; lower values
should be reserved for components of the desktop environment.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>priority</p></dt>
<dd><p>A 8-bit signed priority value</p></dd>
<dd> </dd>
</dl>
sq~wxq~t& XfceSMClient*sm_client,guint8prioritytvoidt"xfce_sm_client_set_restart_commandsq~
tû
<p>Sets the application's "restart" command, which is used to restart
the application and restore any saved state from the previous
run.</p>
<p>If unset, defaults to the command used to start this instance
of the application, with session management related arguments
added (if not already present).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>restart_command</p></dt>
<dd><p>An argument vector</p></dd>
<dd> </dd>
</dl>
sq~wxq~#t. XfceSMClient*sm_client,gchar**restart_commandtvoidt xfce_sm_client_set_restart_stylesq~
t
<p>Sets the restart style hint to restart_style
.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>sm_client</p></dt>
<dd><p>An XfceSMClient</p></dd>
<dd> </dd>
<dt><p>restart_style</p></dt>
<dd><p>An XfceSMClientRestartStyle value</p></dd>
<dd> </dd>
</dl>
sq~wxq~)t= XfceSMClient*sm_client,XfceSMClientRestartStylerestart_styletvoidt
xfce_spawnsq~
tÐ
<p>Like gdk_spawn_on_screen(), but also supports startup notification
(if Libxfce4ui was built with startup notification support).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>screen</p></dt>
<dd><p>a GdkScreen or NULL to use the active screen,
see xfce_gdk_screen_get_active(). </p></dd>
<dd>[allow-none]</dd>
<dt><p>working_directory</p></dt>
<dd><p>child's current working directory or NULL to
inherit parent's. </p></dd>
<dd>[allow-none]</dd>
<dt><p>argv</p></dt>
<dd><p>child's argument vector.</p></dd>
<dd> </dd>
<dt><p>envp</p></dt>
<dd><p>child's environment vector or NULL to inherit
parent's. </p></dd>
<dd>[allow-none]</dd>
<dt><p>flags</p></dt>
<dd><p>flags from GSpawnFlags. G_SPAWN_DO_NOT_REAP_CHILD
is not allowed, use xfce_spawn_on_screen_with_child_watch()
if you want a child watch.</p></dd>
<dd> </dd>
<dt><p>startup_notify</p></dt>
<dd><p>whether to use startup notification.</p></dd>
<dd> </dd>
<dt><p>startup_timestamp</p></dt>
<dd><p>the timestamp to pass to startup notification, use
the event time here if possible to make focus
stealing prevention work property. If you don't
have direct access to the event time you could use
gtk_get_current_event_time() or if nothing is
available 0 is valid too.</p></dd>
<dd> </dd>
<dt><p>startup_icon_name</p></dt>
<dd><p>application icon or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>child_process</p></dt>
<dd><p>TRUE if the process should be a child process,
FALSE if it should be reparented to init.</p></dd>
<dd> </dd>
<dt><p>error</p></dt>
<dd><p>return location for errors or NULL. </p></dd>
<dd>[out][allow-none][transfer full]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE on success, FALSE if error
is set.</p>
<p>Since: 4.16</p>
sq~wxq~/tÈ GdkScreen*screen,constgchar*working_directory,gchar**argv,gchar**envp,GSpawnFlagsflags,gbooleanstartup_notify,guint32startup_timestamp,constgchar*startup_icon_name,gbooleanchild_process,GError**errortgbooleantxfce_spawn_command_linesq~
tù
<p>Executes the given command_line
and returns TRUE if the
command terminated successfully. Else, the error
is set
to the standard error output.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>screen</p></dt>
<dd><p>a GdkScreen or NULL to use the active screen, see xfce_gdk_screen_get_active(). </p></dd>
<dd>[allow-none]</dd>
<dt><p>command_line</p></dt>
<dd><p>command line to run.</p></dd>
<dd> </dd>
<dt><p>in_terminal</p></dt>
<dd><p>whether to run command_line
in a terminal.</p></dd>
<dd> </dd>
<dt><p>startup_notify</p></dt>
<dd><p>whether to use startup notification.</p></dd>
<dd> </dd>
<dt><p>child_process</p></dt>
<dd><p>TRUE if the process should be a child process, FALSE if it should be reparented to init.</p></dd>
<dd> </dd>
<dt><p>error</p></dt>
<dd><p>location for a GError or NULL. </p></dd>
<dd>[out][allow-none][transfer full]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if the command_line
was executed
successfully, FALSE if error
is set.</p>
<p>Since: 4.16</p>
sq~wxq~5tx GdkScreen*screen,constgchar*command_line,gbooleanin_terminal,gbooleanstartup_notify,gbooleanchild_process,GError**errortgbooleant!xfce_spawn_command_line_on_screensq~
tý
<p>xfce_spawn_command_line_on_screen has been deprecated since version 4.16 and should not be used in newly-written code.</p>
<p>Use xfce_spawn_command_line instead.</p>
<p>Executes the given command_line
and returns TRUE if the
command terminated successfully. Else, the error
is set
to the standard error output.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>screen</p></dt>
<dd><p>a GdkScreen or NULL to use the active screen, see xfce_gdk_screen_get_active(). </p></dd>
<dd>[allow-none]</dd>
<dt><p>command_line</p></dt>
<dd><p>command line to run.</p></dd>
<dd> </dd>
<dt><p>in_terminal</p></dt>
<dd><p>whether to run command_line
in a terminal.</p></dd>
<dd> </dd>
<dt><p>startup_notify</p></dt>
<dd><p>whether to use startup notification.</p></dd>
<dd> </dd>
<dt><p>error</p></dt>
<dd><p>location for a GError or NULL. </p></dd>
<dd>[out][allow-none][transfer full]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if the command_line
was executed
successfully, FALSE if error
is set.</p>
sq~wxq~;tb GdkScreen*screen,constgchar*command_line,gbooleanin_terminal,gbooleanstartup_notify,GError**errortgbooleantxfce_spawn_on_screensq~
tº
<p>xfce_spawn_on_screen has been deprecated since version 4.16 and should not be used in newly-written code.</p>
<p>Use xfce_spawn instead.</p>
<p>Like gdk_spawn_on_screen(), but also supports startup notification
(if Libxfce4ui was built with startup notification support).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>screen</p></dt>
<dd><p>a GdkScreen or NULL to use the active screen,
see xfce_gdk_screen_get_active(). </p></dd>
<dd>[allow-none]</dd>
<dt><p>working_directory</p></dt>
<dd><p>child's current working directory or NULL to
inherit parent's. </p></dd>
<dd>[allow-none]</dd>
<dt><p>argv</p></dt>
<dd><p>child's argument vector.</p></dd>
<dd> </dd>
<dt><p>envp</p></dt>
<dd><p>child's environment vector or NULL to inherit
parent's. </p></dd>
<dd>[allow-none]</dd>
<dt><p>flags</p></dt>
<dd><p>flags from GSpawnFlags. G_SPAWN_DO_NOT_REAP_CHILD
is not allowed, use xfce_spawn_on_screen_with_child_watch()
if you want a child watch.</p></dd>
<dd> </dd>
<dt><p>startup_notify</p></dt>
<dd><p>whether to use startup notification.</p></dd>
<dd> </dd>
<dt><p>startup_timestamp</p></dt>
<dd><p>the timestamp to pass to startup notification, use
the event time here if possible to make focus
stealing prevention work property. If you don't
have direct access to the event time you could use
gtk_get_current_event_time() or if nothing is
available 0 is valid too.</p></dd>
<dd> </dd>
<dt><p>startup_icon_name</p></dt>
<dd><p>application icon or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>error</p></dt>
<dd><p>return location for errors or NULL. </p></dd>
<dd>[out][allow-none][transfer full]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE on success, FALSE if error
is set.</p>
sq~wxq~At² GdkScreen*screen,constgchar*working_directory,gchar**argv,gchar**envp,GSpawnFlagsflags,gbooleanstartup_notify,guint32startup_timestamp,constgchar*startup_icon_name,GError**errortgbooleant%xfce_spawn_on_screen_with_child_watchsq~
t k
<p>Like xfce_spawn_on_screen(), but allows to attach a closure to watch the
child's exit status. This because only one g_child_watch_add() is allowed on
Unix (per PID) and this is already internally needed for a proper
startup notification implementation.</p>
<p>Example 2. Spawning with a child watch</p>
<dl>
<dt>static void
child_watch_callback (GObject *object,
gint status)
{
g_message ("Child exit status is %d", status);
}
static void
spawn_something (void)
{
GClosure *child_watch;
child_watch = g_cclosure_new_swap (G_CALLBACK (child_watch_callback),
object, NULL);
xfce_spawn_on_screen_with_child_watch (...,
child_watch,
...);
}</dt>
</dl>
<br><br>Parameters</br></br>
<dl>
<dt><p>screen</p></dt>
<dd><p>a GdkScreen or NULL to use the active screen,
see xfce_gdk_screen_get_active(). </p></dd>
<dd>[allow-none]</dd>
<dt><p>working_directory</p></dt>
<dd><p>child's current working directory or NULL to
inherit parent's. </p></dd>
<dd>[allow-none]</dd>
<dt><p>argv</p></dt>
<dd><p>child's argument vector.</p></dd>
<dd> </dd>
<dt><p>envp</p></dt>
<dd><p>child's environment vector or NULL to inherit
parent's. </p></dd>
<dd>[allow-none]</dd>
<dt><p>flags</p></dt>
<dd><p>flags from GSpawnFlags. G_SPAWN_DO_NOT_REAP_CHILD
is not allowed, you should use the
child_watch_closure
for this.</p></dd>
<dd> </dd>
<dt><p>startup_notify</p></dt>
<dd><p>whether to use startup notification.</p></dd>
<dd> </dd>
<dt><p>startup_timestamp</p></dt>
<dd><p>the timestamp to pass to startup notification, use
the event time here if possible to make focus
stealing prevention work property. If you don't
have direct access to the event time you could use
gtk_get_current_event_time() or if nothing is
available 0 is valid too.</p></dd>
<dd> </dd>
<dt><p>startup_icon_name</p></dt>
<dd><p>application icon or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>child_watch_closure</p></dt>
<dd><p>closure that is triggered when the child exists
or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>error</p></dt>
<dd><p>return location for errors or NULL. </p></dd>
<dd>[out][allow-none][transfer full]</dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE on success, FALSE if error
is set.</p>
sq~wxq~GtÏ GdkScreen*screen,constgchar*working_directory,gchar**argv,gchar**envp,GSpawnFlagsflags,gbooleanstartup_notify,guint32startup_timestamp,constgchar*startup_icon_name,GClosure*child_watch_closure,GError**errortgbooleant$xfce_titled_dialog_add_action_widgetsq~
tX
<p>This function is a replacement for gtk_dialog_add_action_widget and assumes that
you have called xfce_titled_dialog_create_action_area before.</p>
<p>Children with GTK_RESPONSE_HELP will be added to the secondary group of children
(see gtk_button_box_set_child_secondary for reference).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>titled_dialog</p></dt>
<dd><p>a XfceTitledDialog.</p></dd>
<dd> </dd>
<dt><p>child</p></dt>
<dd><p>an activatable widget.</p></dd>
<dd> </dd>
<dt><p>response_id</p></dt>
<dd><p>response ID for child
.</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~Mt? XfceTitledDialog*titled_dialog,GtkWidget*child,gintresponse_idtvoidtxfce_titled_dialog_add_buttonsq~
t¯
<p>This function is a replacement for gtk_dialog_add_button and assumes that
you have called xfce_titled_dialog_create_action_area before.</p>
<p>Buttons with GTK_RESPONSE_HELP will be added to the secondary group of children
(see gtk_button_box_set_child_secondary for reference).</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>titled_dialog</p></dt>
<dd><p>a XfceTitledDialog.</p></dd>
<dd> </dd>
<dt><p>button_text</p></dt>
<dd><p>text of button.</p></dd>
<dd> </dd>
<dt><p>response_id</p></dt>
<dd><p>response ID for child
.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p>the GtkButton widget that was added. </p>
<p>[transfer none]</p>
<p>Since: 4.16</p>
sq~wxq~StF XfceTitledDialog*titled_dialog,constgchar*button_text,gintresponse_idt GtkWidgett%xfce_titled_dialog_create_action_areasq~
t
<p>This function creates a custom action area (of type GtkButtonBox) and has to
be used in combination with xfce_titled_dialog_add_action_widget.</p>
<p>When using the XfceTitledDialogClass directly to create dialogs this function is
useful to keep action widgets out of the GtkHeaderBar in which they would
normally end up by calling gtk_dialog_add_action_widget.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>titled_dialog</p></dt>
<dd><p>a XfceTitledDialog.</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~Yt XfceTitledDialog*titled_dialogtvoidtxfce_titled_dialog_get_subtitlesq~
tƒ
<p>Returns the subtitle of the titled_dialog
, or NULL
if no subtitle is displayed in the titled_dialog
.
This is just a convenience function around gtk_header_bar_get_subtitle.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>titled_dialog</p></dt>
<dd><p>a XfceTitledDialog.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> the subtitle of titled_dialog
, or NULL.</p>
sq~wxq~_t XfceTitledDialog*titled_dialogtconsttxfce_titled_dialog_newsq~
t}
<p>Allocates a new XfceTitledDialog instance.</p>
<br><br>Returns</br></br>
<p> the newly allocated XfceTitledDialog.</p>
sq~wxq~et voidt GtkWidgett#xfce_titled_dialog_new_with_buttonssq~
t¾
<p>xfce_titled_dialog_new_with_buttons has been deprecated since version 4.16 and should not be used in newly-written code.</p>
<p>Use xfce_titled_dialog_new_with_mixed_buttons instead.</p>
<p>See the documentation of gtk_dialog_new_with_buttons() for details about the
parameters and the returned dialog.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>title</p></dt>
<dd><p>title of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>parent</p></dt>
<dd><p>transient parent window of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>flags</p></dt>
<dd><p>from GtkDialogFlags.</p></dd>
<dd> </dd>
<dt><p>first_button_text</p></dt>
<dd><p>stock ID or text to go in first, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>...</p></dt>
<dd><p>response ID for the first button, then additional buttons, ending with NULL.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> the newly allocated XfceTitledDialog.</p>
sq~wxq~ktW constgchar*title,GtkWindow*parent,GtkDialogFlagsflags,constgchar*first_button_text,...t GtkWidgett)xfce_titled_dialog_new_with_mixed_buttonssq~
tƒ
<p>Creates an XfceTitledDialog using xfce_gtk_button_new_mixed. This allows
the buttons to use an optional named or stock icon.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>title</p></dt>
<dd><p>title of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>parent</p></dt>
<dd><p>transient parent window of the dialog, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>flags</p></dt>
<dd><p>from GtkDialogFlags.</p></dd>
<dd> </dd>
<dt><p>first_button_icon_name</p></dt>
<dd><p>icon name to go in first, or "" for no icon.</p></dd>
<dd> </dd>
<dt><p>first_button_text</p></dt>
<dd><p>text to go in first, or NULL. </p></dd>
<dd>[allow-none]</dd>
<dt><p>...</p></dt>
<dd><p>response ID for the first button, then additional buttons, ending with NULL.</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> the newly allocated XfceTitledDialog.</p>
<p>Since: 4.14</p>
sq~wxq~qty constgchar*title,GtkWindow*parent,GtkDialogFlagsflags,constgchar*first_button_icon_name,constgchar*first_button_text,...t GtkWidgett'xfce_titled_dialog_set_default_responsesq~
t
<p>Sets the last widget in the dialog’s action area with the given response_id
as the default widget for the dialog. Pressing “Enter†normally activates
the default widget.</p>
<p>This function is a replacement for gtk_dialog_set_default_response, which does
not work with XfceTitledDialog.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>titled_dialog</p></dt>
<dd><p>a XfceTitledDialog.</p></dd>
<dd> </dd>
<dt><p>response_id</p></dt>
<dd><p>a response ID</p></dd>
<dd> </dd>
</dl>
<p>Since: 4.16</p>
sq~wxq~wt/ XfceTitledDialog*titled_dialog,gintresponse_idtvoidtxfce_titled_dialog_set_subtitlesq~
tÀ
<p>Sets the subtitle displayed by titled_dialog
to subtitle
; if
subtitle
is NULL no subtitle will be displayed by the titled_dialog
.
This is just a convenience function around gtk_header_bar_set_subtitle.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>titled_dialog</p></dt>
<dd><p>a XfceTitledDialog.</p></dd>
<dd> </dd>
<dt><p>subtitle</p></dt>
<dd><p>the new subtitle for the titled_dialog
, or NULL.</p></dd>
<dd> </dd>
</dl>
sq~wxq~}t3 XfceTitledDialog*titled_dialog,constgchar*subtitletvoidtxfce_widget_reparentsq~
t·
<p>Moves a widget from one GtkContainer to another, handling reference
count issues to avoid destroying the widget.</p>
<br><br>Parameters</br></br>
<dl>
<dt><p>widget</p></dt>
<dd><p>a GtkWidget.</p></dd>
<dd> </dd>
<dt><p>new_parent</p></dt>
<dd><p>a GtkContainer to move the widget into</p></dd>
<dd> </dd>
</dl>
<br><br>Returns</br></br>
<p> TRUE if the widget could be moved, FALSE otherwise.</p>
<p>Since: 4.14</p>
sq~wxq~ƒt& GtkWidget*widget,GtkWidget*new_parenttgbooleanxsq~?@wx