----------------------------------------------------------------------- RSSリーダプラグイン for Chararina プラグイン関数マニュアル Copyright(C) 2004 Praesens, Inc. All rights reserved. http://www.praesens.co.jp/pws/ ----------------------------------------------------------------------- １.はじめに RSSリーダプラグインプラグインをダウンロードいただきありがとうござ います．RSSリーダプラグイン(以下本プラグイン)はChararina(キャラリ ナ)上で動作するキャラクターと連動することが可能なプラグインです． 2,3章でキャラクターとの連携に用いるプラグイン関数の使用方法について 説明しますので，本プラグインに対応したキャラクターを作成する方はご覧 下さい． 本プラグインは常駐プラグインです．キャラクターからLoadPlugin関数を用 いてプラグインのロードをする必要はありません． ２.コールバック関数 RSSリーダからの各種イベントを受け取る為のコールバック関数です． これらのコールバック関数に対して処理を行うことで，RSSリーダの動作に あわせた動作が可能となります． これらのコールバックは複数キャラクターが起動していた場合は，全て のキャラクターに対して行われます(該当するコールバック関数が定義され ていなかった場合は除く) export void LF_RP_cNotifyUpdate( int kind,int result ); 機能 RSSリーダの記事更新終了時にシステムから呼び出されます．常に割 り込み属性で呼ばれます． 更新手続き中にエラーが発生した場合はresultにエラーがあったサイ ト数を負値にしたものを渡してこの関数が呼ばれます． 引数 kind : イベントの種類を示し，以下の数字が渡されます． 0: 自動更新でユーザ定期更新チェックOnにしているサイトの チェックを行った． 1: ユーザが手動で全サイトのチェックを行った(ランキング結果の 更新も同時に行う) 2: ユーザが手動で1サイトのチェックを行った 3: ユーザが手動でランキング結果の更新を行った 4: 綾織関数で全サイトの更新チェックを行った [1.10ベータ版より] 5: 綾織関数でランキング結果の更新チェックを行った[1.10ベータ版より] result: 0以上の場合は更新されたサイト数，負値の場合はエラーが あったサイト数を返します． export void LF_RP_cNotifyUpdateStop(); [Ver1.01正式版より] 機能 RSSリーダの記事更新時に更新処理が中断された際にシステムから呼 び出されます。 引数 なし export void LF_RP_cNotifyTickerChange( string istring ); 機能 Tickerモード表示時に，表示する見出しが切り替わるタイミングで システムから呼ばれます．常に割り込み属性で呼ばれます． 引数 istring: いまから表示しようとする記事情報が渡されます． この値には複数の値がまとめて代入されており，個別の値 を取り出す場合は後述の"LF_RP_GetParameter"関数を使用 してください． また，istring一つが1つの記事を表します． export void LF_RP_cNotifyTickerClick( string istring ); 機能 Tickerモード表示時に，ユーザが現在表示されている記事見出しを クリックした際にシステムからコールバックされます． 常に割り込み属性で呼ばれます． 引数 istring: ユーザがクリックした記事情報が渡されます． 仕様は"LF_RP_cNotifyTickerChange"コールバックに渡さ れるistring文字列と同様で複数の値がまとめてあり， 個別の値を取り出す場合は後述の"LF_RP_GetParameter"を 使用してください． export LF_RP_cNotifySiteNameClick( string istring ); 機能 Tickerモード表示時に，ユーザが現在表示されているサイト名 をクリックした際にシステムからコールバックされます． 常に割り込み属性で呼ばれます． [※1.10ベータ版より追加] 引数 istring: ユーザがクリックしたサイト情報が渡されます． 仕様は"LF_RP_cNotifyTickerChange"コールバックに渡さ れるistring文字列と同様で複数の値がまとめてあり， 個別の値を取り出す場合は後述の"LF_RP_GetParameter"を 使用してください． export void LF_RP_cChangeViewMode( int mode ); 機能 RSSリーダがフルモードからTickerモード等表示形態が変わった時， 及び 最小化された際にシステムから呼ばれます． 引数 mode: 新しく切り替わるモードが渡されます． 0: Tickerモード 1: 最小化 2: フルモード 戻り値 なし ３.プラグイン関数 RSSリーダプラグインは綾織から呼び出せる下記のプラグイン関数を実装し ています．キャラクターからこれらのプラグイン関数を呼び出すことで， キャラクターからRSSリーダプラグインを操作できます． ３．１ 更新関数 import int LF_RP_UpdateAll(); 機能 自動更新設定がオンになっているサイトの全更新を行う。但しこの関 数は更新処理を開始した時点で関数を抜けるので更新終了時になんら かの処理を行いたい場合はLF_RP_cNotifyUpdate内で処理を行ってください。 [※1.10ベータ版より追加] 引数 なし 戻り値 1: 正常 0: 失敗(既に更新中, オフライン等) -1: 該当サイトが0だった(自動更新設定がオンになっているサイトが ひとつもなかった) import int LF_RP_UpdateRanking(); 機能 ランキングの更新処理を実行します。 [※1.10ベータ版より追加] 引数 なし 戻り値 1: 正常 0: 失敗(既に更新中, オフライン等) import boolean LF_RP_IsUpdating(); 機能 更新処理中であるかどうかを返す。 [※1.10ベータ版より追加] 引数 なし 戻り値 true: 更新中である(LF_RP_UpdateAll,LF_RP_UpdateRanking関数で 更新することができない) false: 更新中ではない。 ３．２ 共通関数 import string LF_RP_GetParameter( string istring, string key ); 機能 LF_RP_cNotifyTickerChangeコールバックで渡されるistring， LF_RP_GetRankingDataで取得できるistringを元に，記事に対するURL, タイトルなどを取得します． 引数 istring: LF_RP_cNotifyTickerChange等でシステムから渡される見出 しなどの記事情報を指定します． 詳細はLF_RP_cNotifyTickerChangeのistringの説明を参照 してください． key: istringから抜き出す値のキー名を指定してください． (詳細は備考に記載) キー名の大文字・小文字の区別はありません． 戻り値 該当するキーに対応する値を返します． ただし該当する項目がなかった場合はNULLを返します． 備考 key: 指定するキー名の一覧 -- 共通 "title": 記事見出し "link": 記事見出しの内容が置いてあるURL "decription": 記事の概略 "date": 記事の作成または公開日付け (YYYYmmDDHHMMSS形式) -- 以下 LF_RP_cNotifyTickerChange, LF_RP_cNotifySiteNameClickから取得した時のみ "channel_title": rdfの置いてあるサイトのタイトル "channel_link": rdfの置いてあるサイトのURL "channel_desc": rdfの置いてあるサイトの概略 -- 以下 LF_RP_GetRankingDataで取得した場合のみ有効 "related_count": この記事に関連する記事の数(これが多いもの がランキングの上位にきている) import int LF_RP_GetRankingDataCount() 機能 システムが作成した全てのランキング結果の数を取得します． 引数 なし 戻り値 現在取得できるランキングの数を返します． ランキング結果を未ダウンロードの場合は-1をします． import string LF_RP_GetRankingData( int n ) 機能 システムが作成したランキング結果の取得をします． 引数 n: 取得するランキング記事のインデックスを指定します． nはLF_RP_GetRankingDataCount()で取得した数-1まで指定できます． nが小さいほどランクが高いものが取得できます． 戻り値 見出しなどをまとめた文字列を返します． (LF_RP_cNotifyTickerChangeのistring引数と同様の形式) ここでかえされた文字列は，LF_RP_GetParameterを使用することで 個別の値を取得することができます． nが範囲外，まだランキングデータ未取得の場合はNULLを返します． import int LF_RP_GetRankingKeywords( string keywords[], int counts[], int n ) 引数 keywords[]: 引数nで指定したランキング結果に含まれるキーワード群 を返します．可変長配列1要素に1単語の形式でキーワー ドが格納されます． counts[]: 引数nで指定したランキング結果に含まれるキーワード群 の出現回数を返します．可変長配列1要素に1出現回数が 格納されます． 例えばkeywords[x]の出現回数はcounts[x]に格納されま す． n: 取得するランキング記事のインデックスを指定します． "LF_RP_GetRankingData"関数の引数と同じものです． ※nは0〜LF_RP_GetRankingDataCountで得られた数 - 1の範囲 戻り値 1: 正常 0: 失敗 -1: 失敗(ランキングデータをまだ取得していない) import int LF_RP_GetLastRankingDatetime() 機能 システムが最新のランキング結果を取得した時刻を返します． 引数 なし 戻り値 システムが最新のランキング結果を取得した時刻を， 1970年1月1日0時0分0秒からの現在までの経過秒数(Time関数が返す値と 同様の形式)で返します． import int LF_RP_GetViewMode(); 機能 現在のRSSリーダの表示状態を返します． 引数 なし 戻り値 mode: 値についてはLF_RP_cChangeViewModeのmode引数の解説を参照し てください ４.著作権，免責事項など 知的財産権 ・本ソフトウェア(画像・ドキュメントを含む)に関する一切の著作権その他 の無体財産権は，プラエセンス株式会社が所有します． 禁止事項 ・お客様は，本ソフトウェアについて，変更，改変，複製を行うことはでき ません． ・お客様は，本ソフトウェアについて，リバースエンジニアリング，逆コン パイル・逆アセンブル，その他の方法でソースコードを解析することはで きません．また，本ソフトウェアが生成するデータファイルについて，リ バースエンジニアリングすることはできません． 免責事項 ・本ソフトウェアは現状のままで提供されるものであり，当社は，本ソフト ウェアに関して，完全性・正確性・有用性・第三者の権利不侵害性・その 他一切の保証を致しません． ・当社は，本ソフトウェアの瑕疵，不具合等ならびに本ソフトウェアを使用 した結果および使用不可につき，修補義務・保守義務・その他いかなる責 任も負いません． ５. 変更履歴 2005/8/2 Version 1.20β2(Chararina Ver3.20β2版以降に添付) ・更新直後にティッカーに"最新の記事はありません"と表示されることがある点を修正 ・更新後に見出しが複数重なって表示されることがある点を修正 2005/6/2 Version 1.20β(Chararina Ver3.20β版以降に添付) ・ランキング結果をダウンロードするサーバを変更した ・フルモードでカテゴリが"全ての記事を表示"になっていた場合，Ticker モードから見出しをクリックしてフルモードに切り替えた際に，記事該当 カテゴリに代わっていたのを変わらないようにした ・Tickerモード時のメモリー使用量を低減した ・更新時に一時的に常に手前表示設定を解除するようにした ・内部のデータ形式を変更 2004/12/1 Version 1.10(Chararina Ver3.10正式版に添付) ・[自動]カテゴリ選択時にチェックサイトを削除するとアクセス違反が発生 することがあった点を修正 2004/9/28 Version 1.10β(Chararina Ver3.10βに添付) ・ティッカーモード時スキンに対応 ・スキン対応に伴い2行表示スキン及びコンパクトスキンを追加 ・フルモードにおいて見出し境界を見易くした ・セキュリティ設定の追加 ・タブ表示に対応 ・Google検索バーの追加 ・最近閉じたページメニューの追加 ・全更新、ランキング更新の綾織関数を実装 ・Mozilla ActiveX Controlに対応(非サポート機能とします。 また使用する為にはMozilla ActiveX Controlをインストールする必要が あります) ・ティッカーの表示状態をChararina終了時に記憶するようにした 2004/8/26 Version 1.02(Chararina Ver3.02正式版に添付) ・関連記事の一部のリンクが正常に動作しないことがある点を修正(Ver1.02 βのみの現象) 2004/8/20 Version 1.02β(Chararina Ver3.02βに添付) ・WindowsXP SP2環境において"RSSリーダプラグイン"をフルモードに切り 替え時にエラーが発生する点を修正 ・−などの一部文字が化けていた点を修正 ・記事見出しの重複判定アルゴリズムを変更 ・ティッカーの見出し位置をできるだけリセットしないようにした 2004/8/6 Version 1.01(Chararina Ver3.01正式版に添付) ・ティッカー表示の際のリソースリークを解消 ・画面端、タスクバーに吸い付くようにした ・エラーメッセージを変更 2004/7/23 Version 1.01β2 ・更新エラーが発生した際にアクセス違反が起こることがある点を修正(β1 のみの現象) ・ランキングをティッカーに表示できるようにした ・"マウスがあるウインドウにフォーカスを持たせる"設定の使い勝手を向上 ・ティッカーウインドウの右クリックメニューに"ヘルプ"をつけた ・認証付きプロキシーサーバに対応した ・InternetExplorerの設定が"オフライン作業"の際は自動更新を行わない ようにした。 2004/7/12 Version 1.01β1 ・更新処理の中断ができるようにした ・クラスタリング結果をDL中は，n/N形式で進捗を表示するようにした ・更新中断をキャラクターに通知する"LF_RP_cNotifyUpdateStop"を追加 ・フルモードのボタンサイズ2倍表示モードを追加 ・フルモードの閉じるボタンで最小化する機能をつけた ・ティッカーウインドウサイズ2倍表示モードを追加 ・ティッカーのスクロール速度，停止時間の調整をできるようにした ・ティッカーモード時に既読の記事は表示しない設定を追加した ・次回起動時に前回表示していた見出しから表示するようにした ・見出し部、ブラウザ部、関連記事部で自動的にフォーカスを移動する設定 を追加した 2004/7/1 Version 1.00 ・一部のランキングが表示されない点を修正。 ・自動更新中はタスクバーに表示しないようにした。 2004/6/24 Version 1.00β2 ・ティッカークリック時に該当記事が表示されないことがある点を修正 ・URLのアップロード機能を正常動作するようにした ・それに伴い、URLをアップロードしない設定をつけた ・マニュアルを添付 ・関連記事内のサイト名には下線をつけた ・最新の記事がない状態で見出しをクリックすとエラーになる点を修正 ・自動更新が正常に動作しないことがある点を修正 2004/6/17 Version 1.00β ファーストバージョン作成