AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

docs: Update templates

Browse Source
This commit is contained in:
Javier Jardón 2010-10-19 03:31:02 +02:00
parent bf4ee1b52b
commit 04900c8caa
24 changed files with 260 additions and 254 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/reference/gdk/tmpl/drawing.sgml
View File

@ -45,52 +45,6 @@ or a #GdkWindow.
</para>
<!-- ##### FUNCTION gdk_drawable_get_screen ##### -->
<para>
</para>
@drawable:
@Returns:
<!-- ##### FUNCTION gdk_drawable_get_visual ##### -->
<para>
</para>
@drawable:
@Returns:
<!-- ##### FUNCTION gdk_drawable_set_colormap ##### -->
<para>
</para>
@drawable:
@colormap:
<!-- ##### FUNCTION gdk_drawable_get_depth ##### -->
<para>
</para>
@drawable:
@Returns:
<!-- ##### FUNCTION gdk_drawable_get_size ##### -->
<para>
</para>
@drawable:
@width:
@height:
<!-- ##### FUNCTION gdk_drawable_get_clip_region ##### -->
<para>

36
docs/reference/gdk/tmpl/gdkscreen.sgml
View File

@ -77,33 +77,6 @@ when GDK gets multihead support.
@Returns:
<!-- ##### FUNCTION gdk_screen_get_default_colormap ##### -->
<para>
</para>
@screen:
@Returns:
<!-- ##### FUNCTION gdk_screen_set_default_colormap ##### -->
<para>
</para>
@screen:
@colormap:
<!-- ##### FUNCTION gdk_screen_get_system_colormap ##### -->
<para>
</para>
@screen:
@Returns:
<!-- ##### FUNCTION gdk_screen_get_system_visual ##### -->
<para>
@ -113,15 +86,6 @@ when GDK gets multihead support.
@Returns:
<!-- ##### FUNCTION gdk_screen_get_rgba_colormap ##### -->
<para>
</para>
@screen:
@Returns:
<!-- ##### FUNCTION gdk_screen_get_rgba_visual ##### -->
<para>

18
docs/reference/gdk/tmpl/general.sgml
View File

@ -332,14 +332,7 @@ available.
</para>
@void:
<!-- ##### MACRO gdk_error_trap_pop ##### -->
<para>
</para>
@void:
<!-- ##### FUNCTION gdk_error_trap_pop_ignored ##### -->
@ -347,7 +340,7 @@ available.
</para>
@void:
@void:
<!-- ##### MACRO GDK_WINDOWING_X11 ##### -->
@ -364,10 +357,3 @@ This macro is defined if GDK is configured to use the win32 backend.
<!-- ##### MACRO GDK_WINDOWING_QUARTZ ##### -->
<para>
This macro is defined if GDK is configured to use the Quartz backend.
</para>

8
docs/reference/gdk/tmpl/pango_interaction.sgml
View File

@ -143,8 +143,8 @@ g_object_unref (context);
</para>
@void:
@Returns:
@void:
@Returns:
<!-- ##### FUNCTION gdk_pango_context_get_for_screen ##### -->
@ -152,7 +152,7 @@ g_object_unref (context);
</para>
@screen:
@Returns:
@screen:
@Returns:

4
docs/reference/gdk/tmpl/x_interaction.sgml
View File

@ -358,7 +358,7 @@ Another name for GDK_DRAWABLE_XID().
</para>
@display:
@display:
<!-- ##### FUNCTION gdk_x11_display_error_trap_pop_ignored ##### -->
@ -366,7 +366,7 @@ Another name for GDK_DRAWABLE_XID().
</para>
@display:
@display:
<!-- ##### FUNCTION gdk_x11_display_set_cursor_theme ##### -->

97
docs/reference/gtk/tmpl/gtkcellrenderer.sgml
View File

@ -181,6 +181,11 @@ it cannot be individually modified.
</para>
@parent_class:
@get_request_mode:
@get_preferred_width:
@get_preferred_height_for_width:
@get_preferred_height:
@get_preferred_width_for_height:
@get_size:
@render:
@activate:
@ -210,11 +215,10 @@ it cannot be individually modified.
</para>
@cell:
@window:
@cr:
@widget:
@background_area:
@cell_area:
@expose_area:
@flags:
@ -353,3 +357,92 @@ it cannot be individually modified.
@ypad:
<!-- ##### FUNCTION gtk_cell_renderer_get_preferred_height ##### -->
<para>
</para>
@cell:
@widget:
@minimum_size:
@natural_size:
<!-- ##### FUNCTION gtk_cell_renderer_get_preferred_height_for_width ##### -->
<para>
</para>
@cell:
@widget:
@width:
@minimum_height:
@natural_height:
<!-- ##### FUNCTION gtk_cell_renderer_get_preferred_size ##### -->
<para>
</para>
@cell:
@widget:
@minimum_size:
@natural_size:
<!-- ##### FUNCTION gtk_cell_renderer_get_preferred_width ##### -->
<para>
</para>
@cell:
@widget:
@minimum_size:
@natural_size:
<!-- ##### FUNCTION gtk_cell_renderer_get_preferred_width_for_height ##### -->
<para>
</para>
@cell:
@widget:
@height:
@minimum_width:
@natural_width:
<!-- ##### FUNCTION gtk_cell_renderer_get_request_mode ##### -->
<para>
</para>
@cell:
@Returns:
<!-- ##### FUNCTION gtk_cell_view_get_desired_height_for_width_of_row ##### -->
<para>
</para>
@cell_view:
@path:
@avail_size:
@minimum_size:
@natural_size:
<!-- ##### FUNCTION gtk_cell_view_get_desired_width_of_row ##### -->
<para>
</para>
@cell_view:
@path:
@minimum_size:
@natural_size:

2
docs/reference/gtk/tmpl/gtkcellrendererprogress.sgml
View File

@ -31,7 +31,7 @@ The #GtkCellRendererProgress cell renderer was added in GTK+ 2.6.
</para>
<!-- ##### ARG GtkCellRendererProgress:orientation ##### -->
<!-- ##### ARG GtkCellRendererProgress:inverted ##### -->
<para>
</para>

5
docs/reference/gtk/tmpl/gtkcellrenderertext.sgml
View File

@ -143,6 +143,11 @@ the #GtkCellRendererText allows to edit its text using an entry.
</para>
<!-- ##### ARG GtkCellRendererText:max-width-chars ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRendererText:rise ##### -->
<para>

35
docs/reference/gtk/tmpl/gtkdnd.sgml
View File

@ -224,8 +224,8 @@ drops.
</para>
@context:
@Returns:
@context:
@Returns:
<!-- ##### FUNCTION gtk_drag_highlight ##### -->
@ -271,18 +271,6 @@ a widget.
@hot_y:
<!-- ##### FUNCTION gtk_drag_set_icon_pixmap ##### -->
<para>
</para>
@context:
@colormap:
@pixmap:
@mask:
@hot_x:
@hot_y:
<!-- ##### FUNCTION gtk_drag_set_icon_pixbuf ##### -->
<para>
@ -305,6 +293,15 @@ a widget.
@hot_y:
<!-- ##### FUNCTION gtk_drag_set_icon_surface ##### -->
<para>
</para>
@context:
@surface:
<!-- ##### FUNCTION gtk_drag_set_icon_name ##### -->
<para>
@ -348,16 +345,6 @@ a widget.
@actions:
<!-- ##### FUNCTION gtk_drag_source_set_icon ##### -->
<para>
</para>
@widget:
@colormap:
@pixmap:
@mask:
<!-- ##### FUNCTION gtk_drag_source_set_icon_pixbuf ##### -->
<para>

5
docs/reference/gtk/tmpl/gtkentry.sgml
View File

@ -404,11 +404,6 @@ The #GtkEntry-struct struct contains only private data.
</para>
<!-- ##### ARG GtkEntry:state-hint ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_entry_new ##### -->
<para>

50
docs/reference/gtk/tmpl/gtkenums.sgml
View File

@ -29,29 +29,6 @@ Public enumerated types used throughout GTK+
@GTK_ACCEL_LOCKED:
@GTK_ACCEL_MASK:
<!-- ##### ENUM GtkAnchorType ##### -->
<para>
</para>
@GTK_ANCHOR_CENTER:
@GTK_ANCHOR_NORTH:
@GTK_ANCHOR_NORTH_WEST:
@GTK_ANCHOR_NORTH_EAST:
@GTK_ANCHOR_SOUTH:
@GTK_ANCHOR_SOUTH_WEST:
@GTK_ANCHOR_SOUTH_EAST:
@GTK_ANCHOR_WEST:
@GTK_ANCHOR_EAST:
@GTK_ANCHOR_N:
@GTK_ANCHOR_NW:
@GTK_ANCHOR_NE:
@GTK_ANCHOR_S:
@GTK_ANCHOR_SW:
@GTK_ANCHOR_SE:
@GTK_ANCHOR_W:
@GTK_ANCHOR_E:
<!-- ##### ENUM GtkArrowPlacement ##### -->
<para>
Used to specify the placement of scroll arrows in scrolling menus.
@ -89,7 +66,6 @@ Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
</para>
@GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box.
@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box.
@GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box,
@ -334,7 +310,6 @@ Used to control what selections users are allowed to make.
The Ctrl key may be used to enlarge the selection, and Shift key to select
between the focus and the child pointed to. Some widgets may also allow
Click-drag to select a range of elements.
@GTK_SELECTION_EXTENDED: Deprecated, behaves identical to %GTK_SELECTION_MULTIPLE.
<!-- ##### ENUM GtkShadowType ##### -->
<para>
@ -363,22 +338,6 @@ the widget and the widget will respond to mouse clicks.
@GTK_STATE_INSENSITIVE: State indicating that the widget is
unresponsive to user actions.
<!-- ##### ENUM GtkSubmenuDirection ##### -->
<para>
Indicates the direction a sub-menu will appear.
</para>
@GTK_DIRECTION_LEFT: A sub-menu will appear to the left of the current menu.
@GTK_DIRECTION_RIGHT: A sub-menu will appear to the right of the current menu.
<!-- ##### ENUM GtkSubmenuPlacement ##### -->
<para>
</para>
@GTK_TOP_BOTTOM:
@GTK_LEFT_RIGHT:
<!-- ##### ENUM GtkToolbarStyle ##### -->
<para>
Used to customize the appearance of a #GtkToolbar. Note that
@ -403,15 +362,6 @@ Used by #GtkRange to control the policy for notifying value changes.
@GTK_UPDATE_DISCONTINUOUS: Notify updates when the mouse button has been released
@GTK_UPDATE_DELAYED: Space out updates with a small timeout
<!-- ##### ENUM GtkVisibility ##### -->
<para>
Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
</para>
@GTK_VISIBILITY_NONE: The row is not visible.
@GTK_VISIBILITY_PARTIAL: The row is partially visible.
@GTK_VISIBILITY_FULL: The row is fully visible.
<!-- ##### ENUM GtkWindowPosition ##### -->
<para>
Window placement can be influenced using this enumeration. Note that

45
docs/reference/gtk/tmpl/gtkfeatures.sgml
View File

@ -22,6 +22,51 @@ typically use the features described here.
<!-- ##### SECTION Image ##### -->
<!-- ##### FUNCTION gtk_get_major_version ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_get_minor_version ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_get_micro_version ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_get_binary_age ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_get_interface_age ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_check_version ##### -->
<para>
</para>

5
docs/reference/gtk/tmpl/gtkframe.sgml
View File

@ -74,11 +74,6 @@ a &lt;child&gt; type attribute.
</para>
<!-- ##### ARG GtkFrame:shadow ##### -->
<para>
</para>
<!-- ##### ARG GtkFrame:shadow-type ##### -->
<para>

5
docs/reference/gtk/tmpl/gtkhandlebox.sgml
View File

@ -115,11 +115,6 @@ handlebox are detached from the main window.
</para>
<!-- ##### ARG GtkHandleBox:shadow ##### -->
<para>
</para>
<!-- ##### ARG GtkHandleBox:shadow-type ##### -->
<para>

33
docs/reference/gtk/tmpl/gtkmain.sgml
View File

@ -395,8 +395,8 @@ widget and this function does nothing.
</para>
@void:
@Returns:
@void:
@Returns:
<!-- ##### FUNCTION gtk_grab_remove ##### -->
@ -430,6 +430,15 @@ If @widget does not have the grab, this function does nothing.
@device:
<!-- ##### USER_FUNCTION GtkFunction ##### -->
<para>
</para>
@data:
@Returns:
<!-- ##### FUNCTION gtk_init_add ##### -->
<para>
Registers a function to be called when the mainloop is started.
@ -439,6 +448,7 @@ Registers a function to be called when the mainloop is started.
@data: Data to pass to that function.
@Deprecated: This function is going to be removed in GTK+ 3.0
<!-- ##### FUNCTION gtk_quit_add_destroy ##### -->
<para>
Trigger destruction of @object in case the mainloop at level @main_level
@ -466,6 +476,25 @@ Registers a function to be called when an instance of the mainloop is left.
@Deprecated: This function is going to be removed in GTK+ 3.0
<!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
<para>
</para>
@object:
@data:
@n_args:
@args:
<!-- ##### STRUCT GtkArg ##### -->
<para>
</para>
@type:
@name:
<!-- ##### FUNCTION gtk_quit_add_full ##### -->
<para>
Registers a function to be called when an instance of the mainloop is left.

1
docs/reference/gtk/tmpl/gtkmenu.sgml
View File

@ -245,6 +245,7 @@ Moves a #GtkMenuItem to a new position within the #GtkMenu.
@parent_menu_item:
@func:
@data:
@destroy:
@button:
@activate_time:

14
docs/reference/gtk/tmpl/gtkmenuitem.sgml
View File

@ -78,6 +78,20 @@ submenu. For normal applications, the relevant signal is "activate".
@menuitem: the object which received the signal.
<!-- ##### SIGNAL GtkMenuItem::deselect ##### -->
<para>
</para>
@menuitem: the object which received the signal.
<!-- ##### SIGNAL GtkMenuItem::select ##### -->
<para>
</para>
@menuitem: the object which received the signal.
<!-- ##### SIGNAL GtkMenuItem::toggle-size-allocate ##### -->
<para>

4
docs/reference/gtk/tmpl/gtkprogressbar.sgml
View File

@ -155,7 +155,7 @@ Creates a new #GtkProgressBar.
</para>
@pbar:
@inverted:
@inverted:
<!-- ##### FUNCTION gtk_progress_bar_get_inverted ##### -->
@ -237,3 +237,5 @@ Creates a new #GtkProgressBar.
@pbar:
@Returns:

4
docs/reference/gtk/tmpl/gtkradiomenuitem.sgml
View File

@ -143,7 +143,7 @@ Sets the group of a radio menu item, or changes it.
</para>
@radio_menu_item:
@Returns:
@radio_menu_item:
@Returns:

28
docs/reference/gtk/tmpl/gtkselection.sgml
View File

@ -86,6 +86,34 @@ selection handling code.
@flags:
@info:
<!-- ##### FUNCTION gtk_target_entry_new ##### -->
<para>
</para>
@target:
@flags:
@info:
@Returns:
<!-- ##### FUNCTION gtk_target_entry_copy ##### -->
<para>
</para>
@data:
@Returns:
<!-- ##### FUNCTION gtk_target_entry_free ##### -->
<para>
</para>
@data:
<!-- ##### FUNCTION gtk_target_list_new ##### -->
<para>
</para>

23
docs/reference/gtk/tmpl/gtkstatusicon.sgml
View File

@ -115,11 +115,6 @@ on Win32 doesn't allow to embed arbitrary widgets.
@arg1:
@Returns:
<!-- ##### ARG GtkStatusIcon:blinking ##### -->
<para>
</para>
<!-- ##### ARG GtkStatusIcon:embedded ##### -->
<para>
@ -465,24 +460,6 @@ on Win32 doesn't allow to embed arbitrary widgets.
@Returns:
<!-- ##### FUNCTION gtk_status_icon_set_blinking ##### -->
<para>
</para>
@status_icon:
@blinking:
<!-- ##### FUNCTION gtk_status_icon_get_blinking ##### -->
<para>
</para>
@status_icon:
@Returns:
<!-- ##### FUNCTION gtk_status_icon_is_embedded ##### -->
<para>

9
docs/reference/gtk/tmpl/gtktextview.sgml
View File

@ -89,15 +89,6 @@ types related to the text widget and how they work together.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTextView::page-horizontally ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
@arg2:
<!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
<para>

5
docs/reference/gtk/tmpl/gtktreeview.sgml
View File

@ -367,11 +367,6 @@ internal GtkTreeSelection in UI definitions.
</para>
<!-- ##### ARG GtkTreeView:row-ending-details ##### -->
<para>
</para>
<!-- ##### ARG GtkTreeView:tree-line-pattern ##### -->
<para>

32
docs/reference/gtk/tmpl/gtkuimanager.sgml
View File

@ -336,7 +336,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@add_tearoffs:
@ -345,7 +345,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@Returns:
@ -354,7 +354,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@action_group:
@pos:
@ -364,7 +364,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@action_group:
@ -373,7 +373,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@Returns:
@ -382,7 +382,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@Returns:
@ -391,7 +391,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@path:
@Returns:
@ -401,7 +401,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@types:
@Returns:
@ -411,7 +411,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@path:
@Returns:
@ -421,7 +421,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@buffer:
@length:
@error:
@ -433,7 +433,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@filename:
@error:
@Returns:
@ -444,7 +444,7 @@ members and should not be accessed directly.
</para>
@self:
@manager:
@Returns:
@ -471,7 +471,7 @@ what UI element to create.
</para>
@self:
@manager:
@merge_id:
@path:
@name:
@ -485,7 +485,7 @@ what UI element to create.
</para>
@self:
@manager:
@merge_id:
@ -494,7 +494,7 @@ what UI element to create.
</para>
@self:
@manager:
@Returns:
@ -503,6 +503,6 @@ what UI element to create.
</para>
@self:
@manager: