ruby-****@sourc*****
ruby-****@sourc*****
2006年 7月 16日 (日) 21:53:59 JST
-------------------------
REMOTE_ADDR = 81.62.207.204
REMOTE_HOST =
REMOTE_USER = ruby-gnome2-hiki
URL = /hiki.cgi?Gtk%3A%3AAssistant
-------------------------
@@ -19,15 +19,17 @@
== Class Methods
---- Gtk::PrintJob.new()
- Creates a new Gtk::Assistant.
+--- Gtk::Assistant.new()
+ Creates a new Gtk::Assistant.
+ ((*Since 2.10*))
- * Returns: a new Gtk::Assitant
+ * Returns: a new Gtk::Assitant
== Instance Methods
--- current_page
Returns the page number of the current page.
+ ((*Since 2.10*))
* Returns: The index (starting from 0) of the current page in
the assistant, if the assistant has no pages, -1 will be
@@ -36,7 +38,10 @@
--- current_page=(page_num)
Switches the page to page_num. Note that this will only be
necessary in custom buttons, as the assistant flow can be set
- with #set_forward_page_func.
+ with Gtk::Assistant#set_forward_page_func.
+ ((*Since 2.10*))
* page_num: index of the page to switch to, starting from 0.
If negative, the last page will be used. If greater than
@@ -45,11 +48,16 @@
--- get_n_pages
Returns the number of pages in the assistant.
+ ((*Since 2.10*))
* Returns: The number of pages in the assistant.
--- get_nth_page(page_num)
Returns the child widget contained in page number page_num.
+ ((*Since 2.10*))
* page_num: The index of a page in the assistant, or -1 to
get the last page;
@@ -58,18 +63,26 @@
--- prepend_page(page)
Prepends a page to the assistant.
+ ((*Since 2.10*))
* page: a Gtk::Widget
* Returns: the index (starting at 0) of the inserted page
--- append_page(page)
Appends a page to the assistant.
+ ((*Since 2.10*))
* page: a Gtk::Widget
* Returns: the index (starting at 0) of the inserted page
--- insert_page(page, position)
Inserts a page in the assistant at a given position.
+ ((*Since 2.10*))
* page: a Gtk::Widget
* position: the index (starting at 0) at which to insert the
@@ -82,6 +90,15 @@
when the user presses the forward button. Setting page_func
to nil will make the assistant to use the default forward
function, which just goes to the next visible page.
+ ((*Since 2.10*))
* page_func: the block to use; passed argument is the page
number used to calculate the next page, from which it must
@@ -91,6 +100,16 @@
--- set_page_type(page, type)
Sets the page type for the specified page. The page type
determines the page behavior in the assistant.
+ ((*Since 2.10*))
* page: a page of assitant
* type: the new type for page (GtkAssistantPageType)
@@ -98,6 +108,17 @@
--- get_page_type(page)
Gets the page type of the specified page.
+ ((*Since 2.10*))
* page: a page of assistant
* Returns: the page type of page (GtkAssistantPageType)
@@ -105,6 +116,18 @@
--- set_page_title(page, title)
Sets a title for the specified page. The title is displayed in the header
area of the assistant when page is the current page.
+ ((*Since 2.10*))
* page: a page of assistant
* title: the new title for page
@@ -112,6 +124,19 @@
--- get_page_title(page)
Gets the title for the specified page.
+ ((*Since 2.10*))
* page: a page of assistant
* Returns: the title for page
@@ -120,6 +133,20 @@
Sets a header image for the specified page. This image is
displayed in the header area of the assistant when page is
the current page.
+ ((*Since 2.10*))
* page: a page of assistant
* pixbuf: the new header image page (Gdk::Pixbuf)
@@ -127,6 +141,21 @@
--- get_page_header_image(page)
Gets the header image for the specified page.
+ ((*Since 2.10*))
* page: a page of assistant
* Returns: the header image for page, or nil if there's no
@@ -136,6 +151,22 @@
Sets a header image for the specified page. This image is
displayed in the side area of the assistant when page is the
current page.
+ ((*Since 2.10*))
* page: a page of assistant
* pixbuf: the new header image page (Gdk::Pixbuf)
@@ -143,6 +159,23 @@
--- get_page_side_image(page)
Gets the header image for the specified page.
+ ((*Since 2.10*))
* page: a page of assistant
* Returns: the side image for page, or nil if there's no side
@@ -152,6 +169,24 @@
Sets whether specified page contents are complete. This will
make assistant update the buttons state to be able to
continue the task.
+ ((*Since 2.10*))
* page: a page of assistant
* complete: the completeness status of the page (true or false)
@@ -159,18 +177,39 @@
--- get_page_complete(page)
Gets whether page is complete.
+ ((*Since 2.10*))
* page: a page of assistant
* Returns: true if page is complete, otherwise false
--- add_action_widget(child)
Adds a widget to the action area of the assistant.
+ ((*Since 2.10*))
* child: a Gtk::Widget
* Returns: self
--- remove_action_widget(child)
Removes a widget from the action area of the assistant.
+ ((*Since 2.10*))
* child: a Gtk::Widget
* Returns: self
@@ -185,8 +206,31 @@
One situation where it can be necessary to call this function
is when changing a value on the current page affects the
future page flow of the assistant.
+ ((*Since 2.10*))
* Returns: self
+
== Constants
=== GtkAssistantPageType
@@ -199,19 +222,47 @@
--- PAGE_CONTENT
The page has regular contents.
+ ((*Since 2.10*))
--- PAGE_INTRO
The page contains an introduction to the assistant task.
+ ((*Since 2.10*))
--- PAGE_CONFIRM
The page lets the user confirm or deny the changes.
+ ((*Since 2.10*))
--- PAGE_SUMMARY
The page informs the user of the changes done.
+ ((*Since 2.10*))
--- PAGE_PROGRESS
Used for tasks that take a long time to complete, blocks the
assistant until the page is marked as complete.
+ ((*Since 2.10*))
== Signals
@@ -227,22 +255,54 @@
type Gtk::Assistant::PAGE_PROGRESS after the confirmation page
and handle this operation within the "prepare" signal of the
progress page.
+ ((*Since 2.10*))
--- cancel: self (run last)
The "cancel" signal is emitted when then the cancel button is
clicked.
+ ((*Since 2.10*))
--- close: self (run last)
The "close" signal is emitted either when the close button of
a summary page is clicked, or when the apply button in the
last page in the flow (of type Gtk::Assistant::PAGE_CONFIRM)
is clicked.
+ ((*Since 2.10*))
--- prepare: self, page (run last)
The "prepared" signal is emitted when a new page is set as
the assistant's current page, before making the new page
visible. A handler for this signal can do any preparation
which are necessary before showing page.
+ ((*Since 2.10*))
* page: the current page