ruby-****@sourc*****
ruby-****@sourc*****
2005年 2月 4日 (金) 23:40:53 JST
-------------------------
REMOTE_ADDR = 218.114.126.13
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/ja/?Gtk
-------------------------
= Gtkモジュール
Gtkモジュールはライブラリの初期化、メインイベントループ、イベントのようなメソッドと一般的な定数を含みます。
Ruby/GTKを使う前には、ウインドウシステムディスプレイへの接続の初期化と、いくつかの標準的なコマンドライン引数の構文解析を行う必要があります。
Gtk.initメソッドはRuby/GTKを初期化します。
他の全てのGUIツールキットのように
Ruby/GTKはイベント駆動プログラミングモデルを用います。
ユーザーが何もしなかった場合、Ruby/GTKはメインループに入り入力を待ちます。
もし何らかのアクション（例えばマウスクリックのような）を行うとメインループは"目を覚ま"し、Ruby/GTKにイベントを届けます。
Ruby/GTKは一つかそれ以上のウィジェットにイベントを転送します。
ウィジェットがイベントを受け取ったとき、それらはしばしば一つかより多くのシグナルを発します。
シグナルはあなたのプログラムに"何か興味深い出来事が起こったぞ"と、あなたがシグナルにGLib::Instantiable#signal_connectと共に関連付けたブロックを呼び出すことで通知します。
ブロックはシグナルに関連付けられ、多くの場合コールバックと呼ばれます。
あなたのコールバックが呼び出されたとき、通常は何らかのアクションをするでしょう。
例えば、「開く」ボタンが押されたときGtk::FileSelectionDialogを表示するかも知れません。
コールバックが終わった後、Ruby/GTKはメインループに戻りユーザーの次の入力を待ちます。
== モジュールメソッド
--- Gtk.set_locale
GTK+に対する国際化サポートを初期化します。Gtk.initは自動的にこれを実行しますが、通常はこのメソッドを呼び出す意味はありません。
もしあなたがGTK+が初期化された後でロケールを変更したいとしたら、このメソッドを呼ぶとわずかに助けになるかも知れません。（注記：しかしながらGTK+が初期化された後にロケールを変更することは、矛盾した結果を引き起こすかも知れず本来はサポート外です）
正確には現在のロケールはプログラム環境に従いセットされます。これはCライブラリ関数のsetlocale(LC_ALL, "")と同じですが、これもまたGDKが用いるウインドウシステムのロケール固有の設定を管理します。
((* Note *))：Ruby-GNOME2は恐らくこのメソッドを将来的にはサポートしません。なぜならsetlocaleはRubyにマッチしないからです。
* 戻り値：ロケールの型に対応した文字列で、通常はlang_COUNTRYという形式です。langにはISO-639の文字コードが、COUNTRYにはISO-3166の国コードが入ります。Unixではこれはsetlocale()の結果と一致し、Windowsのような他のプラットフォームでもよく使われていますが、Cライブラリの場合は異なる結果を返します。この文字列はGTK+によって保持され、変更されたり解放されることはありません。
--- Gtk.disable_setlocale
Gtk.initのsetlocale(LC_ALL, "")の呼び出しを防ぎます。あなたのプログラムをユーザーのロケールより別のロケールにセットしたい場合や、異なるロケールのカテゴリに異なる値を割り当てたい場合にこのメソッドを使いたくなるかも知れません。しかし、ほとんどのプログラムではこのメソッドを呼ぶ必要はないはずです。
((* Note *))：Ruby-GNOME2は恐らくこのメソッドを将来的にはサポートしません。なぜならsetlocaleはRubyにマッチしないからです。
* 戻り値：nil
--- Gtk.default_language
今現在のデフォルトの言語に対するPango::Languageを返します。（これは一つのアプリケーションの実行中に切り替えることが可能なことに注意して下さい）デフォルトの言語は現在のロケールから生成されます。これは例えばGTK+が文字の方向が右から左か、左から右かを決定したりすることに使われます。Windows上での挙動についての_gtk_get_lc_ctype()に対する記述もご覧下さい。
* 戻り値：デフォルトの言語のPango::Language
--- Gtk.init(argv = ARGV)
このメソッドをあなたのGUIアプリケーションの中で他のGTK+メソッドを呼び出す前に呼んでください。これはツールキットの動作と、いくつかの標準的なコマンドラインオプションの構文解析で必要とされる全てのものを初期化します。argvはそれにより調整され、結果的にあなた自身のコードからはそれらの標準的な引数は決して見えなくなります。
注記：このメソッドは何らかの理由でGUIが初期化できなかった場合RuntimeErrorを投げます。
* argv：ARGVの値です。全てのパラメータは戻る前に解体され、Gtk.initにより解釈されます。
* 戻り値：self
--- Gtk.events_pending?
処理待ちのイベントがあるかチェックします。このメソッドはGUIの更新やタイムアウトの呼び出し等に用いることができます。例えば、しばらく重い処理を行うときは次のようにします。
while (Gtk.events_pending?)
Gtk.main_iteration
end
* 戻り値：処理待ちのイベントがある場合true、そうでない場合はfalse
--- Gtk.main
Gtk.main_quitが呼ばれるまでメインループを走らせます。Gtk.mainの呼び出しはネストすることができます。
その場合はGtk.main_quitは最深部のメインループの実行から戻ります。
* 戻り値：nil
--- Gtk.main_level
メインループの現在のネストレベルを尋ねます。これはGtk.quit_addを使う際に便利です。
* 戻り値：現在実行中のメインループのネストレベル
--- Gtk.main_quit
コントロールを取り戻したいときに、最深部のメインループの実行から戻ります。
* 戻り値：nil
--- Gtk.main_iteration
- 一度だけメインループ処理を行います。処理されるイベントが無かった場合、Gtk+は次のイベントが通知されるまでブロックします。もしブロックを望まないならばGtk.main_iteration_doを検討するか、先にGtk.events_pending?で処理待ちのイベントをチェックして下さい。
+ 一度だけメインループ処理を行います。処理待ちのイベントが無かった場合、Gtk+は次のイベントが通知されるまでブロックします。もしブロックを望まないならばGtk.main_iteration_doを検討するか、先にGtk.events_pending?で処理待ちのイベントをチェックして下さい。
* 戻り値：Gtk.main_quitが最深部のメインループに対して呼ばれた場合true
--- Gtk.main_iteration_do(blocking)
- Runs a single iteration of the mainloop. If no events are available either return or block dependent on the value of blocking.
- * blocking: true if you want GTK+ to block if no events are pending.
- * Returns: true if Gtk.main_quit has been called for the innermost mainloop.
+ 一度だけメインループ処理を行います。処理可能なイベントが無かった場合に戻るかブロックするかはblockingの値によります。
+ * blocking：イベントが無かったときにGTK+がブロックして欲しいならばtrue
+ * 戻り値：Gtk.main_quitが最深部のメインループに対して呼ばれた場合true
--- Gtk.main_do_event(event)
Processes a single GDK event. This is public only to allow filtering of events between GDK and GTK+. You will not usually need to call this function directly.
While you should not call this function directly, you might want to know how exactly events are handled. So here is what this function does with the event:
(1) Compress enter/leave notify events. If the event passed build an enter/leave pair together with the next event (peeked from GDK) both events are thrown away. This is to avoid a backlog of (de-)highlighting widgets crossed by the pointer.
(2) Find the widget which got the event. If the widget can't be determined the event is thrown away unless it belongs to a INCR transaction. In that case it is passed to gtk_selection_incr_event() (GTK+ inner function).
(3) Then the event is passed on a stack so you can query the currently handled event with Gtk.current_event.
(4) The event is sent to a widget. If a grab is active all events for widgets that are not in the contained in the grab widget are sent to the latter with a few exceptions:
* Deletion and destruction events are still sent to the event widget for obvious reasons.
* Events which directly relate to the visual representation of the event widget.
* Leave events are delivered to the event widget if there was an enter event delivered to it before without the paired leave event.
* Drag events are not redirected because it is unclear what the semantics of that would be.
Another point of interest might be that all key events are first passed through the key snooper functions if there are any. Read the description of Gtk.key_snooper_install if you need this feature.
(5) After finishing the delivery the event is popped from the event stack.
* event: An Gdk::Event to process (normally) passed by GDK.
--- Gtk.current_event
Obtains a copy of the event currently being processed by GTK+. For example, if you get a "clicked" signal from Gtk::Button, the current event will be the Gdk::EventButton that triggered the "clicked" signal. If there is no current event, the function returns nil.
* Returns: a copy of the current event, or nil if no current event.
--- Gtk.grab_add
Makes widget the current grabbed widget. This means that interaction with other widgets in the same application is blocked and mouse as well as keyboard events are delivered to this widget.
* widget: The widget that grabs keyboard and pointer events.
* Returns: nil
--- Gtk.current
Queries the current grab.
* Returns: The widget which currently has the grab or nil if no grab is active.
--- Gtk.grab_remove
Removes the grab from the given widget. You have to pair calls to Gtk.grab_add and Gtk.grab_remove.
* widget : The widget which gives up the grab.
* Returns: nil
--- Gtk.init_add { ... }
Registers a block to be called when the mainloop is started.
* { ... }: A block to invoke when Gtk.main is called next.
* Returns: nil
--- Gtk.quit_add(main_level) { ... }
Registers a block to be called when an instance of the mainloop is left.
* main_level: Level at which termination the function shall be called. You can pass 0 here to have the function run at the termination of the current mainloop.
* { ... } : A block to call. This should return true to be removed from the list of quit handlers. Otherwise the function might be called again.
* Returns : A handle for this quit handler (you need this for Gtk.quit_remove) or 0 if you passed a nil pointer in function.
--- Gtk.quit_remove(handler_id)
Removes a quit handler by its identifier.
* handler_id: Identifier for the handler returned when installing it.
* Returns: handler_id
--- Gtk.timeout_add(interval){ ... }
Sets a block to be called at regular intervals, with the default priority, G_PRIORITY_DEFAULT(not implemented yet). The function is called repeatedly until it returns false, at which point the timeout is automatically destroyed and the function will not be called again. The first call to the function will be at the end of the first interval.
Note that timeout functions may be delayed, due to the processing of other event sources. Thus they should not be relied on for precise timing. After each call to the timeout function, the time of the next timeout is recalculated based on the current time and the given interval (it does not try to 'catch up' time lost in delays).
* interval: the time between calls to the function, in milliseconds (1/1000ths of a second)
* { ... }: block to call
* Returns: the timout_handler_id of event source.
--- Gtk.timeout_remove(timeout_handler_id)
Removes the given timeout destroying all information about it.
* timeout_handler_id: The identifier returned when installing the timeout.
* Returns: nil
--- Gtk.idle_add { ... }
Causes tahe mainloop to call the given block whenever no events with higher priority are to be processed. The default priority is GTK_PRIORITY_DEFAULT(not implemented yet), which is rather low.
* { ... }: The block to call.
* Returns: a unique handle for this registration.
--- Gtk.idle_add_priority(priority) { ... }
Like Gtk.idle_add this function allows you to have a function called when the event loop is idle. The difference is that you can give a priority different from GLib::PRIORITY_DEFAULT to the idle function.
* priority: The priority which should not be above GLib::PRIORITY_HIGH_IDLE. Note that you will interfere with GTK+ if you use a priority above Gtk::PRIORITY_RESIZE.
--- Gtk.idle_remove(idle_handler_id)
Removes the idle function with the given id.
* idle_handler_id: Identifies the idle function to remove.
* Returns: nil
--- Gtk.key_snooper_install {|grab_widget, event| ... }
Installs a key snooper block, which will get called on all key events before delivering them normally.
* {|grab_widget, event| ... }: a key snooper block which called before normal event delivery. They can be used to implement custom key event handling.
* grab_widget: the widget to which the event will be delivered.
* event: the key event(Gdk::EventKey).
* Returns: true to stop further processing of event, false to continue.
* Returns: a unique id for this key snooper for use with Gtk.key_snooper_remove.
--- Gtk.key_snooper_remove(handler_id)
Removes the key snooper function with the given id.
* handler_id: Identifies the key snooper to remove
--- Gtk.current_event
Obtains a copy of the event currently being processed by GTK+. For example, if you get a "clicked" signal from Gtk::Button, the current event will be the Gdk::EventButton that triggered the "clicked" signal. If there is no current event, the function returns nil.
* Returns: a copy of the current event, or nil if no current event.
--- Gtk.current_event_time
If there is a current event and it has a timestamp, return that timestamp, otherwise return Gdk::Event::CURRENT_TIME.
* Returns: the timestamp from the current event, or Gdk::Event::CURRENT_TIME.
--- Gtk.current_event_state
If there is a current event and it has a state field, return the state, otherwise return nil.
* Returns: the state of the current event(((<GdkModifierType|Gdk::Window::GdkModifierType>))) or nil.
--- Gtk.get_event_widget(event = nil)
If event is nil or the event was not associated with any widget, returns nil, otherwise returns the widget that received the event originally.
* event: a Gdk::Event
* Returns: the widget that originally received event, or nil
--- Gtk.propagate_event(widget, event)
Sends an event to a widget, propagating the event to parent widgets if the event remains unhandled. Events received by GTK+ from GDK normally begin in Gtk.main_do_event. Depending on the type of event, existence of modal dialogs, grabs, etc., the event may be propagated; if so, this function is used. Gtk.propagate_event calls Gtk::Widget#event on each widget it decides to send the event to. So Gtk::Widget#event is the lowest-level function; it simply emits the "event" and possibly an event-specific signal on a widget. Gtk.propagate_event is a bit higher-level, and Gtk.main_do_event is the highest level.
All that said, you most likely don't want to use any of these functions; synthesizing events is rarely needed. Consider asking on the mailing list for better ways to achieve your goals. For example, use gdk_window_invalidate_rect() or gtk_widget_queue_draw() instead of making up expose events.
* widget: a Gtk::Widget
* event: an Gdk::Event
--- Gtk.check_version(required_major, required_minor, required_micro)
Checks that the GTK+ library in use is compatible with the given version. Generally you would pass in the constants Gtk::MAJOR_VERSION, Gtk::MINOR_VERSION, Gtk::MICRO_VERSION as the three arguments to this function; that produces a check that the library in use is compatible with the version of GTK+ the application or module was compiled against.
Compatibility is defined by two things: first the version of the running library is newer than the version required_major.required_minor.required_micro. Second the running library must be binary compatible with the version required_major.required_minor.required_micro (same major version.)
This function is primarily for GTK+ modules; the module can call this function to check that it wasn't loaded into an incompatible version of GTK+. However, such a a check isn't completely reliable, since the module may be linked against an old version of GTK+ and calling the old version of Gtk.check_version, but still get loaded into an application using a newer version of GTK+.
* required_major: the required major version.
* required_minor: the required major version.
* required_micro: the required major version.
* Returns: nil if the GTK+ library is compatible with the given version, or a string describing the version mismatch.
--- Gtk.check_version?(required_major, required_minor, required_micro)
Same as Gtk.check_version, but returns true if the library is compatible with the given version, otherwise false.
* required_major: the required major version.
* required_minor: the required major version.
* required_micro: the required major version.
* Returns: true if the library is compatible with the given version, otherwise false.
== Constants
=== GtkAccelFlags
--- ACCEL_VISIBLE
= 1 << 0
--- ACCEL_LOCKED
= 1 << 1
--- ACCEL_MASK
= 0x07
=== GtkAnchorType
--- ANCHOR_CENTER
--- ANCHOR_NORTH
--- ANCHOR_NORTH_WEST
--- ANCHOR_NORTH_EAST
--- ANCHOR_SOUTH
--- ANCHOR_SOUTH_WEST
--- ANCHOR_SOUTH_EAST
--- ANCHOR_WEST
--- ANCHOR_EAST
--- ANCHOR_N
= ANCHOR_NORTH
--- ANCHOR_NW
= ANCHOR_NORTH_WEST
--- ANCHOR_NE
= ANCHOR_NORTH_EAST
--- ANCHOR_S
= ANCHOR_SOUTH
--- ANCHOR_SW
= ANCHOR_SOUTH_WEST
--- ANCHOR_SE
= ANCHOR_SOUTH_EAST
--- ANCHOR_W
= ANCHOR_WEST
--- ANCHOR_E
= ANCHOR_EAST
=== GtkAttachOptions
Denotes the expansion properties that a widget will have when it (or it's parent) is resized.
--- EXPAND
= 1 << 0. The widget should expand to take up any extra space in its container that has been allocated.
--- SHRINK
= 1 << 1. The widget should shrink as and when possible.
--- FILL
= 1 << 2. The widget should fill the space allocated to it.
=== GtkCornerType
Specifies which corner a child widget should be placed in when packed into a Gtk::ScrolledWindow. This is effectively the opposite of where the scroll bars are placed.
--- CORNER_TOP_LEFT
Place the scrollbars on the right and bottom of the widget (default behaviour).
--- CORNER_BOTTOM_LEFT
Place the scrollbars on the top and right of the widget.
--- CORNER_TOP_RIGHT
Place the scrollbars on the left and bottom of the widget.
--- CORNER_BOTTOM_RIGHT
Place the scrollbars on the top and left of the widget.
=== GtkDeleteType
--- DELETE_CHARS
--- DELETE_WORD_ENDS
delete only the portion of the word to the left/right of cursor if we're in the middle of a word.
--- DELETE_WORDS
--- DELETE_DISPLAY_LINES
--- DELETE_DISPLAY_LINE_ENDS
--- DELETE_PARAGRAPH_ENDS
like C-k in Emacs (or its reverse)
--- DELETE_PARAGRAPHS
C-k in pico, kill whole line
--- DELETE_WHITESPACE
M-\ in Emacs
=== GtkDirectionType
--- DIR_TAB_FORWARD
--- DIR_TAB_BACKWARD
--- DIR_UP
--- DIR_DOWN
--- DIR_LEFT
--- DIR_RIGHT
=== GtkExpanderStyle
Used to specify the style of the expanders drawn by a Gtk::TreeView.
--- EXPANDER_COLLAPSED
The style used for a collapsed subtree.
--- EXPANDER_SEMI_COLLAPSED
Intermediate style used during animation.
--- EXPANDER_SEMI_EXPANDED
Intermediate style used during animation.
--- EXPANDER_EXPANDED
The style used for an expanded subtree.
=== GtkIMPreeditStyle
--- IM_PREEDIT_NOTHING
--- IM_PREEDIT_CALLBACK
=== GtkIMStatusStyle
--- IM_STATUS_NOTHING
--- IM_STATUS_CALLBACK
=== GtkJustification
Used for justifying the text inside a Gtk::Label widget. (See also Gtk::Alignment).
--- JUSTIFY_LEFT
The text is placed at the left edge of the label.
--- JUSTIFY_RIGHT
The text is placed at the right edge of the label.
--- JUSTIFY_CENTER
The text is placed in the center of the label.
--- JUSTIFY_FILL
The text is placed is distributed across the label.
=== GtkMetricType
Used to indicate which metric is used by a Gtk::Ruler.
--- PIXELS
--- INCHES
--- CENTIMETERS
=== GtkMovementStep
--- MOVEMENT_LOGICAL_POSITIONS
move by forw/back graphemes
--- MOVEMENT_VISUAL_POSITIONS
move by left/right graphemes
--- MOVEMENT_WORDS
move by forward/back words
--- MOVEMENT_DISPLAY_LINES
move up/down lines (wrapped lines)
--- MOVEMENT_DISPLAY_LINE_ENDS
move up/down lines (wrapped lines)
--- MOVEMENT_PARAGRAPHS
move up/down paragraphs (newline-ended lines)
--- MOVEMENT_PARAGRAPH_ENDS
move to either end of a paragraph
--- MOVEMENT_PAGES
move by pages
--- MOVEMENT_BUFFER_ENDS
move to ends of the buffer
--- MOVEMENT_HORIZONTAL_PAGES
move horizontally by pages
=== GtkOrientation
Represents the orientation of widgets which can be switched between horizontal and vertical orientation on the fly, like Gtk::Toolbar.
--- ORIENTATION_HORIZONTAL
The widget is in horizontal orientation.
--- ORIENTATION_VERTICAL
The widget is in vertical orientation.
=== GtkPackType
Represents the packing location Gtk::Box children. (See: Gtk::VBox, Gtk::HBox, and Gtk::ButtonBox).
--- PACK_START
The child is packed into the start of the box
--- PACK_END
The child is packed into the end of the box
=== GtkPathPriorityType
--- PATH_PRIO_LOWEST
= 0
--- PATH_PRIO_GTK
= 4
--- PATH_PRIO_APPLICATION
= 8
--- PATH_PRIO_THEME
= 10
--- PATH_PRIO_RC
= 12
--- PATH_PRIO_HIGHEST
= 15
=== GtkPathType
--- PATH_WIDGET
--- PATH_WIDGET_CLASS
--- PATH_CLASS
=== GtkPolicyType
Determines when a scroll bar will be visible.
--- POLICY_ALWAYS
The scrollbar is always visible.
--- POLICY_AUTOMATIC
The scrollbar will appear and disappear as necessary.
--- POLICY_NEVER
The scrollbar will never appear.
=== GtkPositionType
Describes which edge of a widget a certain feature is positioned at, e.g. the tabs of a Gtk::Notebook, the handle of a Gtk::HandleBox or the label of a Gtk::Scale.
--- POS_LEFT
The feature is at the left edge.
--- POS_RIGHT
The feature is at the right edge.
--- POS_TOP
The feature is at the top edge.
--- POS_BOTTOM
The feature is at the bottom edge.
=== GtkReliefStyle
Indicated the relief to be drawn around a Gtk::Button.
--- RELIEF_NORMAL
Draw a normal relief.
--- RELIEF_HALF
A half relief.
--- RELIEF_NONE
No relief.
=== GtkResizeMode
--- RESIZE_PARENT
Pass resize request to the parent
--- RESIZE_QUEUE
Queue resizes on this widget
--- RESIZE_IMMEDIATE
Perform the resizes now
=== GtkScrollType
--- SCROLL_NONE
--- SCROLL_JUMP
--- SCROLL_STEP_BACKWARD
--- SCROLL_STEP_FORWARD
--- SCROLL_PAGE_BACKWARD
--- SCROLL_PAGE_FORWARD
--- SCROLL_STEP_UP
--- SCROLL_STEP_DOWN
--- SCROLL_PAGE_UP
--- SCROLL_PAGE_DOWN
--- SCROLL_STEP_LEFT
--- SCROLL_STEP_RIGHT
--- SCROLL_PAGE_LEFT
--- SCROLL_PAGE_RIGHT
--- SCROLL_START
--- SCROLL_END
=== GtkSelectionMode
Used to control what selections users are allowed to make.
--- SELECTION_NONE
No selection is possible.
--- SELECTION_SINGLE
Zero or one element may be selected.
--- SELECTION_BROWSE
Exactly one element is selected. In some circumstances, such as initially or during a search operation, it's possible for no element to be selected with Gtk::SELECTION_BROWSE. What is really enforced is that the user can't deselect a currently selected element except by selecting another element.
--- SELECTION_MULTIPLE
Any number of elements may be selected. Clicks toggle the state of an item. Any number of elements may be selected. Click-drag selects a range of elements; the Ctrl key may be used to enlarge the selection, and Shift key to select between the focus and the child pointed to.
=== GtkShadowType
Used to change the appearance of an outline typically provided by a Gtk::Frame.
--- SHADOW_NONE
No outline.
--- SHADOW_IN
The outline is bevelled inwards.
--- SHADOW_OUT
The outline is bevelled outwards like a button.
--- SHADOW_ETCHED_IN
The outline itself is an inward bevel, but the frame does
--- SHADOW_ETCHED_OUT
=== GtkStateType
This type indicates the current state of a widget; the state determines how the widget is drawn. The GtkStateType is also used to identify different colors in a Gtk::Style for drawing, so states can be used for subparts of a widget as well as entire widgets.
--- STATE_NORMAL
State during normal operation.
--- STATE_ACTIVE
State of a currently active widget, such as a depressed button.
--- STATE_PRELIGHT
State indicating that the mouse pointer is over the widget and the widget will respond to mouse clicks.
--- STATE_SELECTED
State of a selected item, such the selected row in a list.
--- STATE_INSENSITIVE
State indicating that the widget is unresponsive to user actions.
=== GtkUpdateType
--- UPDATE_CONTINUOUS
--- UPDATE_DISCONTINUOUS
--- UPDATE_DELAYED
=== GtkVisibility
--- VISIBILITY_NONE
The row is not visible.
--- VISIBILITY_PARTIAL
The row is partially visible.
--- VISIBILITY_FULL
The row is fully visible.
=== GtkSortType
Determines the direction of a sort.
--- SORT_ASCENDING
Sorting is in ascending order.
--- SORT_DESCENDING
Sorting is in descending order.
- ((<Masao>))