GLibやGTK+などに関連するライブラリのAPIリファレンスを参照するのに便利なDevhelpの活用例
「GLibやGTK+などに関連するライブラリのAPIリファレンスを参照するのに便利なDevhelpについて」の続きとして、実際にDevhelpを用いてリファレンスマニュアルを参照して幾つかの調べものを実際に行ってみることにする。以下、GLib,GTK+,PyGTKの開発パッケージ(それぞれの「-devel」や「-dev」付きの名前のパッケージ)が全てインストール済みであるものとする。
ここで書いているのは例であり、探したい情報にたどり着くまでには色々なやり方があるため、同じような流れで情報を参照する必要はない。
例1:GLibで処理時間を計測するタイマー機能の関数群の情報を調べる
「GLib Reference Manual - GLib Utilities - Timers」とたどると「Synopsis」に関数一覧があり、それぞれリンク先で情報を参照する(ページ自体は同じなので下にスクロールして見ても可)。
例2:C言語のGTK+でウィンドウを作成するための関数とその引数の情報を調べる
- 「GTK+ Reference Manual - GTK+ Widgets and Objects - Widget Gallery」を開く
- 空のウィンドウ(「Window」とタイトルがあるもの)の画像を選択してGtkWindowのページを開く
- gtk_window_new()についての内容を参照する(引数についてはここにも書いてあるが、「GtkWindowType」をたどって詳しく調べることもできる)
途中までは「GTK+ Reference Manual - GTK+ Widgets and Objects - Windows - GtkWindow」とたどることもできる。また、「GtkWindow」という名前が一度分かってしまえば、「検索」タブに「GtkWindow」と入れて検索結果からGtkWindowのページをすぐに開くこともできるようになる。
例3:C言語のGTK+でボタンをクリックしたときのGObjectシグナルとそのハンドラの引数を調べる
- GTK+ Reference Manual - GTK+ Widgets and Objects - Widget Galleryを開く
- 「Button」と書かれたボタンのある画像を選択してGtkButtonのページを開く
上部の「Signals」からGObjectシグナル一覧に飛び、関係のありそうな「clicked」シグナルのリンクから情報を参照する
途中までは「GTK+ Reference Manual - GTK+ Widgets and Objects - Buttons and Toggles - GtkButton」とたどることもできる。また、例2と同様、名前が分かってしまえば、「検索」タブから「GtkButton」を検索してページをすぐに開くことができるようになる。
例4:PyGTKで利用可能なストックアイコン(内蔵アイコン)の一覧を参照する
- 「検索」タブを選択し、「検索対象」をPyGTKのリファレンスにする
- 入力欄に「stock」と入力
- 結果の「Stock items」を選択したページに一覧がある
ストックアイコンの一覧はGTK+のデモプログラムgtk-demo(PyGTK版はpygtk-demo)の「Stock Item and Icon Browser」からも見(ら)れる。
例5:PyGTKでgtk.VBoxクラスで利用可能なメンバ関数を調べる
- 「検索」タブを選択し、「検索対象」をPyGTKのリファレンスにする
- 入力欄に「vbox」と入力
- gtk.Vboxクラスのページを開き、親クラスのgtk.Boxクラスへのリンクをたどってgtk.Boxクラスのメンバ関数を参照
- gtk.Vboxクラスのページに戻り、実装しているgtk.Buildableインターフェース(Pythonの文法的にはクラス)のメンバ関数を参照
(注:gtk.Vboxクラスのページにはメンバ関数は書かれておらず、継承しているgtk.Boxクラスと実装しているgtk.Buildableインターフェースのメンバ関数のみが使用できる)
