前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク & XML ミドルウェア : SophiaFramework UNIVERSE 5.0
SFBShell
IShell インターフェースのラッパークラスです。
#include <SFBShell.h.hpp>
class SFBShell : public SFBBase;
SFMTYPEDEFWRAPPER(SFBShell)

継承図

SFBShell クラスの継承図

バージョン

BREW 2.0 BREW 2.1 BREW 3.1 BREW 4.0

参照

BREW API IShell

メンバ

パブリック関数
AEECLSID ActiveApplet( Void )
現在実行中のアプレットに関連付けられた AEECLSID を取得します。
Bool AlarmsActive( Void )
アナンシエータ ( 呼び出し表示装置 ) に ANNUN_ALARMCLOCK、ANNUN_COUNTDOWN、または ANNUN_STOPWATCH が設定された場合は、true を返します。
SFCError AppIsInGroup( AEECLSID idApp , AEECLSID idGroup )
指定したグループのメンバシップについて、指定したアプリケーションの ClassID をチェックします。
Bool Beep( BeepType beep , Bool loud = false )
システム ビープ音の発生またはデバイスの振動を行います。
Void BrowseFile( ACharConstPtr file )
BrowseFile( SFXAnsiStringConstRef file )
filename で指定したファイルの拡張子に関連付けられている登録済みのアプレットを検索します。
Void BrowseURL( ACharConstPtr url )
BrowseURL( SFXAnsiStringConstRef url )
url が指している文字列に含まれている URL に関連付けられている登録済みのアプレットを検索します。
Bool Busy( Void )
アプレットの終了が必要な場合に true を返します。
Bool CanStartApplet( AEECLSID clsid )
アプレットの起動に問題がないかどうかを決定するために、 AEE シェルに問い合せます。
SFCError CancelAlarm( AEECLSID clsid , UInt16 userCode )
ISHELL_SetAlarm() で設定されたアラームをキャンセルします。
SFCError CancelTimer( PFNNOTIFY notify = null , VoidPtr data = null )
SFBShell::SetTimer 関数で設定したタイマーをキャンセルします。
Bool CheckPrivLevel( AEECLSID privilege , Bool queryOnly = true )
現在実行しているアプリの特権レベルを指定した値と照合します。
SFCError ClearProperty( AEECLSID clsid , UInt16 wId )
入力クラスに関連付けられている基本モジュールのプロパティ データをクリアします。
SFCError ClearShutdownErrors( Void )
すべてのアプリのエラー状態をクリアにします。
SFCError CloseApplet( Bool returnToIdle = false )
AEE シェルに対し、アクティブなアプレットをクローズするよう指示します。
SFCError CreateDialog( ACharConstPtr resFile , UInt16 id )
CreateDialog( SFXAnsiStringConstRef resFile , UInt16 id )
CreateDialog( DialogInfo* info )
AEE シェルに対し、入力された DialogInfo データ構造に関連するダイアログ、または関連するリソースファイルのダイアログ情報に関連付けられたダイアログを起動するよう指示します。
SFCError CreateInstance( AEECLSID clsid , SFBBaseSmpPtr handle )
指定した ClassID のオブジェクトを作成して返します。
SFBBaseSmp CreateInstance( AEECLSID clsid )
指定した ClassID のオブジェクトを作成して返します。
SFCError DetectType( VoidConstPtr data , UInt32Ptr size , ACharConstPtr name , ACharConstHandle mime )
DetectType( SFXBufferConstRef data , UInt32Ptr additional , SFXAnsiStringPtr mime )
DetectType( VoidConstPtr data , UInt32Ptr size , SFXAnsiStringPtr mime )
DetectType( SFXBufferConstRef data , UInt32Ptr additional , SFXAnsiStringConstRef name , SFXAnsiStringPtr mime )
DetectType( VoidConstPtr data , UInt32Ptr size , SFXAnsiStringConstRef name , SFXAnsiStringPtr mime )
DetectType( SFXBufferConstRef data , UInt32Ptr additional , ACharConstPtr name , ACharConstHandle mime )
指定したバッファ内のデータ、 または指定したオブジェクト名の MIME タイプを取得します。
SFCError EndDialog( Void )
現在アクティブなダイアログをクローズします。
Void EnumAppletInit( Void )
AEE シェルの内部アプレットの列挙インデックスをリセットします。
AEECLSID EnumNextApplet( AEEAppInfo* info )
次のアプレットに関する情報を取得します。
Bool ForceExit( Void )
アプレットの終了が必要な場合に true を返します。
Void FreeResData( VoidPtr data )
前回 SFBShell::LoadResData 関数から返されたデータを解放します。
SFBDialogSmp GetActiveDialog( Void )
現在アクティブなダイアログを返します。
SInt32 GetAppAuthor( WCharPtr buf , SInt32 size )
GetAppAuthor( SFXWideStringPtr string )
アクティブなアプレットの作成者の名前を取得します。
SInt32 GetAppCopyright( WCharPtr buf , SInt32 size )
GetAppCopyright( SFXWideStringPtr string )
アクティブなアプレットの著作権文字列を取得します。
SInt32 GetAppPrefs( UInt16 version , VoidPtr buf , UInt16 size )
GetAppPrefs( UInt16 version , SFXBufferPtr buf )
アプレットのプリファレンスが含まれる構造体を取得する方法を取得します。
SInt32 GetAppVersion( WCharPtr buf , SInt32 size )
GetAppVersion( SFXWideStringPtr string )
アクティブなアプレットのバージョン文字列を取得します。
UInt32 GetClassItemID( AEECLSID clsid )
指定したClassID を所有しているモジュールに割り当てられた 32 ビット値を取得します。
Void GetDeviceInfo( AEEDeviceInfo* info )
デバイスの機能 ( サポートしている RAM の量、表示ディスプレイ、その他 ) に関する情報を AEE シェルから取得します。
SFCError GetDeviceInfoEx( AEEDeviceItem item , VoidPtr info , SInt32Ptr size )
GetDeviceInfoEx( AEEDeviceItem item , SFXBufferPtr info )
デバイスに関する特定の情報を取得します。
AEECLSID GetHandler( AEECLSID type , ACharConstPtr in )
GetHandler( AEECLSID type , SFXAnsiStringConstRef in )
コンテンツ ビューアおよびプロトコル方式のハンドラを AEE シェルから取得します。
static
SFBShellSmp
GetInstance( Void )
SFBShell クラスのインスタンスを取得します。
Void GetItemStyle( AEEItemType type , AEEItemStyle* normal , AEEItemStyle* selected )
メニュー、アイコン、またはリスト項目のデフォルトスタイルに関する情報を AEE シェルから取得します。
Void GetJulianDate( UInt32 seconds , JulianType* date )
入力された秒数に基づいて JulianType データ構造体に取得します。
SInt32 GetPrefs( AEECLSID clsid , UInt16 version , VoidPtr config , UInt16 size )
GetPrefs( AEECLSID clsid , UInt16 version , SFXBufferPtr config )
アプレットまたはクラスのレベル プリファレンスが含まれる構造体を取得する方法を取得します。
SFCError GetProperty( AEECLSID clsid , UInt16 wId , VoidPtr dest , UInt16Ptr size )
GetProperty( AEECLSID clsid , UInt16 wId , SFXBufferPtr dest )
入力クラスに関連付けられている基本モジュールのプロパティデータを取得します。
UInt32 GetResSize( ACharConstPtr file , UInt16 id , ResType type , UInt32Ptr size )
GetResSize( SFXAnsiStringConstRef file , UInt16 id , ResType type , UInt32Ptr size )
タイプと ID で指定したリソースを、指定のリソース コンテキストからロードします。 ISHELL_LoadResDataEx() のラッパー関数です。
UInt32 GetTimeMS( Void )
現在の時刻をミリ秒で取得します。
UInt32 GetTimerExpiration( PFNNOTIFY notify , VoidPtr data = null )
デバイスのユーザーコールバックまたはユーザーデータに関連付けられたタイマーが満了するまでの残存時間をミリ秒で取得します。
UInt32 GetUpTimeMS( Void )
デバイスに電源が投入されてからの経過時間をミリ秒で取得します。
Bool HandleEvent( AEEEvent event , UInt16 wParam , UInt32 dwParam )
HandleEvent( SFXEventConstRef event )
指定した標準 AEE イベントを現在アクティブなアプレットに送ります。
Bool IsValidResource( ACharConstPtr file , UInt16 id , ResType resType , AEEHandlerType handlerType )
IsValidResource( SFXAnsiStringConstRef file , UInt16 id , ResType resType , AEEHandlerType handlerType )
指定したリソース ファイルのエントリが、 指定したタイプについて有効かどうかをチェックします。
SFBBitmapSmp LoadBitmap( ACharConstPtr file )
LoadBitmap( SFXAnsiStringConstRef file )
ビットマップ ファイルからビットマップを直接読み込み、 そのビットマップを扱う SFBBitmap クラスのインスタンスを返します。
SFBImageSmp LoadBusyImage( Void )
BREW がビジーであることを示すために使われる画像をロードします。
SFBImageSmp LoadImage( ACharConstPtr file )
LoadImage( SFXAnsiStringConstRef file )
画像ファイルからイメージ データを直接読み込み、 そのイメージ データを扱う SFBImage クラスのインスタンスを返します。
SFBBitmapSmp LoadResBitmap( ACharConstPtr resFile , UInt16 id )
LoadResBitmap( SFXAnsiStringConstRef resFile , UInt16 id )
指定したリソースファイルから ID に対応するビットマップを読み込み、 そのビットマップを扱う SFBBitmap クラスのインスタンスを返します。
VoidPtr LoadResData( ACharConstPtr resFile , UInt16 id , ResType type )
LoadResData( SFXAnsiStringConstRef resFile , UInt16 id , ResType type )
指定したリソースファイル、ID、およびタイプに関連付けられた データブロックを返します。
VoidPtr LoadResDataEx( ACharConstPtr resFile , UInt16 id , ResType type , VoidPtr buf , UInt32Ptr size )
LoadResDataEx( SFXAnsiStringConstRef resFile , UInt16 id , ResType type , SFXBufferPtr buf )
LoadResDataEx( SFXAnsiStringConstRef resFile , UInt16 id , ResType type , VoidPtr buf , UInt32Ptr size )
指定したリソース ファイルから ID とタイプで指定したリソース データを読み込み、 buf で指定したバッファに格納します。
SFBImageSmp LoadResImage( ACharConstPtr resFile , UInt16 id )
LoadResImage( SFXAnsiStringConstRef resFile , UInt16 id )
指定したリソース ファイルから ID に対応するイメージを読み込み、 そのイメージを扱う SFBImage クラスのインスタンスを返します。
SFBBaseSmp LoadResObject( ACharConstPtr resFile , UInt16 id , AEECLSID clsidBase )
LoadResObject( SFXAnsiStringConstRef resFile , UInt16 id , AEECLSID clsidBase )
指定されたリソース ファイルから ID とタイプが一致するリソースを読み込み、 そのリソースを扱うクラスのインスタンスを返します。
SFBSoundPlayerSmp LoadResSound( ACharConstPtr resFile , UInt16 id )
LoadResSound( SFXAnsiStringConstRef resFile , UInt16 id )
リソースファイルに未加工のストリームバイトのサウンドデータが含まれている場合に使用します。
SInt32 LoadResString( ACharConstPtr resFile , UInt16 id , WCharPtr buf , SInt32 size )
指定したリソースファイルに格納された UNICODE または ISOLATIN 文字列を取得します。
SFXWideString LoadResString( SFXAnsiStringConstRef resFile , UInt16 id )
指定したリソースファイルに格納された UNICODE または ISOLATIN 文字列を取得します。
SInt32 LoadResString( ACharConstPtr resFile , UInt16 id , SFXWideStringPtr string )
LoadResString( SFXAnsiStringConstRef resFile , UInt16 id , SFXWideStringPtr string )
指定したリソースファイルに格納された UNICODE または ISOLATIN 文字列を取得します。
SFBSoundPlayerSmp LoadSound( ACharConstPtr resFile )
LoadSound( SFXAnsiStringConstRef resFile )
サウンド ファイルからサウンド データを直接読み込み、 そのサウンドを扱う SFBSoundPlayer クラスのインスタンスを返します。
Bool MessageBox( ACharConstPtr resFile , UInt16 titleId , UInt16 textId )
MessageBox( SFXAnsiStringConstRef resFile , UInt16 titleId , UInt16 textId )
指定したリソース ファイルから ID を元にタイトルとテキストを取得し、 メッセージ ボックスを表示します。
Bool MessageBoxText( WCharConstPtr title , WCharConstPtr text )
MessageBoxText( SFXWideStringConstRef title , SFXWideStringConstRef text )
引数で指定した文字列を使用してタイトルとテキストを設定し、 メッセージ ボックスを表示します。
SFCError Notify( AEECLSID clsid , UInt32 mask , VoidPtr data )
特定のイベントが発生したことを指定したアプレットに通知します。
Void OnAppClose( SFXCallbackPtr callback )
アプレットの終了時に呼び出されるコールバック関数を登録します。
Void OnExit( SFXCallbackPtr callback )
BREW の終了時に呼び出されるコールバック関数を登録します。
Void OnInit( SFXCallbackPtr callback )
BREW の初期化のときに呼び出されるコールバック関数を登録します。
Void OnLowRAM( SFXCallbackPtr callback )
システムのメモリが少量になったときに呼び出されるコールバック関数を登録します。
Void OnLowRAMCritical( SFXCallbackPtr callback )
システムメモリが少なくなり、充分な RAM が AEE_SCB_LOW_RAM コールバックによっても確保できなかった場合にコールされるコールバックを登録します。
Void OnLowStorage( SFXCallbackPtr callback )
ファイル システム容量が少量になったときに呼び出されるコールバック関数を登録します。
Void OnModUnload( SFXCallbackPtr callback )
モジュールがアンロードされる直前に呼び出されるコールバック関数を登録します。
Bool PostEvent( AEECLSID clsid , AEEEvent event , UInt16 wValue , UInt32 dwValue )
PostEvent( AEECLSID clsid , SFXEventConstRef event )
指定したアプレットに対し非同期イベントをポストします。
Bool PostEventEx( UInt16 flags , AEECLSID clsid , AEEEvent event , UInt16 wValue , UInt32 dwValue )
PostEventEx( UInt16 flags , AEECLSID clsid , SFXEventConstRef event )
指定したアプレットに対し非同期イベントをポストします。
Bool PostURL( ACharConstPtr url )
URL のスキームに関連付けられたアプレットに対し、非同期のイベントとして EVT_APP_POST_URL イベントをポストします。
Bool Prompt( AEEPromptInfo* info )
アプリがマルチ選択のプロンプトを表示するメカニズムを備えています。
Bool QueryClass( AEECLSID clsid , AEEAppInfo* info )
指定したクラスまたはアプレットが、サポートされているかどうかを確認します。
AEEEvent RegisterEvent( ACharConstPtr name , SInt32Ptr count )
RegisterEvent( SFXAnsiStringConstRef name , SInt32Ptr count )
入力文字列を基にしたカスタム AEEEvent を登録します。
SFCError RegisterHandler( AEECLSID clsidBase , ACharConstPtr in , AEECLSID clsid )
RegisterHandler( AEECLSID clsidBase , SFXAnsiStringConstRef in , AEECLSID clsid )
コンテンツ ビューアまたはプロトコル エンジンが自らを AEE シェルに登録します
SFCError RegisterNotify( AEECLSID clsidNotify , AEECLSID clsidType , UInt32 mask )
他のクラスから発行される通知を登録します。 SFBShell::RegisterNotify 関数で登録した通知は、アプリが実行しているときだけ受け取りが可能です。
Void RegisterSystemCallback( SFXCallbackPtr callback , SInt32 type )
重要なシステムイベント ( BREW の起動、アプリの終了、モジュールのアンロードなど ) に対するコールバック関数を登録します。
SFCError Reset( AEEResetType type )
デバイスをリセットします。
Void Resume( SFXCallbackPtr callback )
リジューム時に呼び出されるコールバック関数を登録します。
SFCError ResumeAlarms( Void )
BREW アラーム機能の再開を促します。
Bool SendEvent( AEECLSID clsid , AEEEvent event , UInt16 wParam , UInt32 dwParam )
SendEvent( AEECLSID clsid , SFXEventConstRef event )
指定したアプレットに対して、即座にイベントを送信します。
Bool SendURL( ACharConstPtr url )
SendURL( SFXAnsiStringConstRef url )
URL のスキームに関連付けられたアプレットに対し、同期のイベントとして EVT_APP_POST_URL イベントを送ります。
SFCError SetAlarm( AEECLSID clsid , UInt16 code , UInt32 minutes )
アラーム ( 満了までの時間が長い ) をアプレットに設定します。
SFCError SetAppPrefs( UInt16 version , VoidPtr config , UInt16 size )
SetAppPrefs( UInt16 version , SFXBufferPtr config )
アプレット固有のプリファレンスが含まれる構造体を設定します。
SFCError SetPrefs( AEECLSID clsid , UInt16 version , VoidPtr config , UInt16 size )
SetPrefs( AEECLSID clsid , UInt16 version , SFXBufferPtr config )
アプレット固有のプリファレンスを設定します。
SFCError SetProperty( AEECLSID clsid , UInt16 wId , VoidPtr src , UInt16 size )
SetProperty( AEECLSID clsid , UInt16 wId , SFXBufferPtr src )
入力クラスに関連付けられている基本モジュールのプロパティ データを設定します。
SFCError SetTimer( SInt32 mSecs , PFNNOTIFY notify , VoidPtr data = null )
タイマーを設定します。
SFCError SetTimerEx( SInt32 mSecs , SFXCallbackPtr callback )
コールバック構造体を使ってタイマーを設定します。
Bool ShowCopyright( Void )
アプレットの著作権情報を表示します。
SFCError StartApplet( AEECLSID clsid )
指定した ClassID に関連付けられたアプレットを起動します。
SFCError StartAppletArgs( AEECLSID clsid , ACharConstPtr args )
StartAppletArgs( AEECLSID clsid , SFXAnsiStringConstRef args )
指定した ClassID に関連付けられたアプレットを起動し、 コマンドライン引数を渡します。
SFCError StartAppletEx( AEECLSID clsid , UInt16 flags )
指定したフラグに従って、 ClassID に関連付けられたアプレットを起動します。
SFCError StartBackgroundApplet( AEECLSID clsid , ACharConstPtr args )
StartBackgroundApplet( AEECLSID clsid , SFXAnsiStringConstRef args )
指定した ClassID に関連付けられたアプレットを起動し、 コマンドライン引数を渡します。
SFCError UnregisterHandler( SFXAnsiStringConstRef in )
ハンドラを登録解除します。

SFBShell::ActiveApplet
現在実行中のアプレットに関連付けられた AEECLSID を取得します。
[ public ]
AEECLSID ActiveApplet(Void);

参照

BREW API ISHELL_ActiveApplet | SFBShell::StartApplet | SFBShell::CloseApplet | SFBShell::CanStartApplet


SFBShell::AlarmsActive
アナンシエータ ( 呼び出し表示装置 ) に ANNUN_ALARMCLOCK、ANNUN_COUNTDOWN、または ANNUN_STOPWATCH が設定された場合は、true を返します。
[ public ]
Bool AlarmsActive(Void);

戻り値

  • 待機中のアラームがあるとき : true
  • 待機中のアラームがないとき : false

参照

BREW API ISHELL_AlarmsActive | SFBDisplay::SetAnnunciators


SFBShell::AppIsInGroup
指定したグループのメンバシップについて、指定したアプリケーションの ClassID をチェックします。
[ public ]
SFCError AppIsInGroup(
    AEECLSID idApp     // アクセスを確認するためのアプリケーション ClassID
    AEECLSID idGroup   // グループ ID
);

戻り値

  • 指定した特権レベルをサポートしているとき : SFERR_NO_ERROR
  • idApp が有効なアプリケーション ClassID でないとき : SFERR_CLASS_UNSUPPORTED
  • 指定した特権をサポートしていないとき : EPRIVLEVEL

バージョン

この関数は、BREW 3.1 から使用可能です。

参照

BREW API ISHELL_AppIsInGroup | BREW API AEE特権レベル | SFBShell::CheckPrivLevel


SFBShell::Beep
システム ビープ音の発生またはデバイスの振動を行います。
[ public ]
Bool Beep(
    BeepType beep       // ビープ音の種別
    Bool loud = false   // true の場合は、高い音量
);

戻り値

  • ビープ音を発生したとき : true
  • ビープ音を発生しなかったとき : false

参照

BREW API ISHELL_Beep | BeepType


SFBShell::BrowseFile
filename で指定したファイルの拡張子に関連付けられている登録済みのアプレットを検索します。
[ public ]
Void BrowseFile(
    ACharConstPtr file   // ファイル名
);
[ public ]
Void BrowseFile(
    SFXAnsiStringConstRef file   // ファイル名
);

参照

BREW API ISHELL_BrowseFile | SFBShell::RegisterHandler | SFBShell::GetHandler | SFBShell::BrowseURL


SFBShell::BrowseURL
url が指している文字列に含まれている URL に関連付けられている登録済みのアプレットを検索します。
[ public ]
Void BrowseURL(
    ACharConstPtr url   // URL
);
[ public ]
Void BrowseURL(
    SFXAnsiStringConstRef url   // URL
);

参照

BREW API ISHELL_BrowseURL | SFBShell::RegisterHandler | SFBShell::GetHandler | SFBShell::BrowseFile


SFBShell::Busy
アプレットの終了が必要な場合に true を返します。
[ public ]
Bool Busy(Void);

戻り値

  • アプレットが処理を中止して終了する必要があるとき : true
  • アプレットが処理を継続できるとき : false

参照

BREW API ISHELL_Busy | SFBShell::ForceExit


SFBShell::CanStartApplet
アプレットの起動に問題がないかどうかを決定するために、 AEE シェルに問い合せます。
[ public ]
Bool CanStartApplet(
    AEECLSID clsid   // ClassID
);

戻り値

  • アプレットの起動が可能なとき : true
  • アプレットの起動が不可能なとき : false

参照

BREW API ISHELL_CanStartApplet | SFBShell::StartApplet | SFBShell::CloseApplet | SFBShell::ActiveApplet


SFBShell::CancelAlarm
ISHELL_SetAlarm() で設定されたアラームをキャンセルします。
[ public ]
SFCError CancelAlarm(
    AEECLSID clsid    // アプレットの ClassID
    UInt16 userCode   // ユーザーコード
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED

参照

BREW API ISHELL_CancelAlarm | SFBShell::SetAlarm


SFBShell::CancelTimer
SFBShell::SetTimer 関数で設定したタイマーをキャンセルします。
[ public ]
SFCError CancelTimer(
    PFNNOTIFY notify = null   // コールバック関数
    VoidPtr data = null       // ユーザーデータ
);

戻り値

SFERR_NO_ERROR を返します。

使用例

設定中のタイマーをキャンセルします。

SFBShellSmp     shell = SFBShell::GetInstance();

// 設定中のタイマーをキャンセルする
shell->CancelTimer(OnTimerEntry, this);

参照

BREW API ISHELL_CancelTimer | PFNNOTIFY | SFBShell::SetTimer | SFBShell::GetTimerExpiration


SFBShell::CheckPrivLevel
現在実行しているアプリの特権レベルを指定した値と照合します。
[ public ]
Bool CheckPrivLevel(
    AEECLSID privilege      // 特権ビット
    Bool queryOnly = true   // 問い合わせのみの場合は true を指定する
);

戻り値

  • 指定した特権レベルをサポートしているとき : true
  • 指定した特権レベルをサポートしていないとき : false

使用例

ファイルにアクセスできるか確認します。

Bool            ok    = false;
SFBShellSmp     shell = SFBShell::GetInstance();

// アプレットの特権レベルを確認する
// ファイルにアクセスできるか確認する
ok = shell->CheckPrivLevel(PL_FILE, true);

参照

BREW API ISHELL_CheckPrivLevel | BREW API AEE特権レベル


SFBShell::ClearProperty
入力クラスに関連付けられている基本モジュールのプロパティ データをクリアします。
[ public ]
SFCError ClearProperty(
    AEECLSID clsid   // 問い合わせるアプリケーションのクラス
    UInt16 wId       // プロパティ ID
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 入力クラスが見つからないとき : EBADCLASS
  • コール側に充分な特権がないとき : EPRIVLEVEL

バージョン

この関数は、BREW 3.0 から使用可能です。

解説

この関数の呼び出しは、 SFBShell::SetProperty(clsid, wId, null, 0); を呼び出すことと同じです。

参照

SFBShell::SetProperty | SFBShell::GetProperty


SFBShell::ClearShutdownErrors
すべてのアプリのエラー状態をクリアにします。
[ public ]
SFCError ClearShutdow(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_NO_MEMORY
  • 特権がないとき : EPRIVLEVEL

バージョン

この関数は、BREW 3.0 のみ使用可能です。

参照

SFBShell::StartApplet | SFBShell::StartAppletEx


SFBShell::CloseApplet
AEE シェルに対し、アクティブなアプレットをクローズするよう指示します。
[ public ]
SFCError CloseApplet(
    Bool returnToIdle = false   // true の場合はアプレットをクローズし、アイドルに戻る
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED
  • 特権がないとき : EPRIVLEVEL

使用例

アプレットをクローズします。

SFBShellSmp     shell = SFBShell::GetInstance();

// アプレットをクローズする
shell->CloseApplet(false);

参照

BREW API ISHELL_CloseApplet | SFBShell::StartApplet | SFBShell::CanStartApplet | SFBShell::ActiveApplet


SFBShell::CreateDialog
AEE シェルに対し、入力された DialogInfo データ構造に関連するダイアログ、または関連するリソースファイルのダイアログ情報に関連付けられたダイアログを起動するよう指示します。
[ public ]
SFCError CreateDialog(
    ACharConstPtr resFile   // リソース ファイル
    UInt16 id               // リソース ID
);
[ public ]
SFCError CreateDialog(
    DialogInfo* info   // ダイアログ情報の代わりとなる構造体
);
[ public ]
SFCError CreateDialog(
    SFXAnsiStringConstRef resFile   // リソース ファイル
    UInt16 id                       // リソース ID
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • 失敗したとき : SFERR_FAILED

参照

BREW API ISHELL_CreateDialog | DialogInfo | SFBShell::GetActiveDialog | SFBShell::EndDialog | SFBDialog::SetFocus | SFBDialog::GetControl


SFBShell::CreateInstance
指定した ClassID のオブジェクトを作成して返します。
[ public ]
SFCError CreateInstance(
    AEECLSID clsid         // ClassID
    SFBBaseSmpPtr handle   // スマートポインターのポインター
);
[ public ]
SFBBaseSmp CreateInstance(
    AEECLSID clsid   // ClassID
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 指定したクラスがサポートされていないとき : SFERR_CLASS_UNSUPPORTED

参照

BREW API ISHELL_CreateInstance | SFBModule::CreateInstance


SFBShell::DetectType
指定したバッファ内のデータ、 または指定したオブジェクト名の MIME タイプを取得します。
[ public ]
SFCError DetectType(
    VoidConstPtr data       // データバッファ
    UInt32Ptr size          // データサイズ
    ACharConstPtr name      // オブジェクト名
    ACharConstHandle mime   // MIME 文字列を受け取るハンドル
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data   // データバッファ
    UInt32Ptr additional     // 出力時、型検出のために必要な余分のバイト数( バッファサイズに自動的に初期化される )
    ACharConstPtr name       // オブジェクト名
    ACharConstHandle mime    // MIME 文字列を受け取るハンドル
);
[ public ]
SFCError DetectType(
    VoidConstPtr data            // データバッファ
    UInt32Ptr size               // データサイズ
    SFXAnsiStringConstRef name   // オブジェクト名
    SFXAnsiStringPtr mime        // MIME 文字列を受け取るハンドル
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data       // データバッファ
    UInt32Ptr additional         // 出力時、型検出のために必要な余分のバイト数( バッファサイズに自動的に初期化される )
    SFXAnsiStringConstRef name   // オブジェクト名
    SFXAnsiStringPtr mime        // MIME 文字列を受け取るハンドル
);
[ public ]
SFCError DetectType(
    VoidConstPtr data       // データバッファ
    UInt32Ptr size          // データサイズ
    SFXAnsiStringPtr mime   // MIME 文字列を受け取るハンドル
);
[ public ]
SFCError DetectType(
    SFXBufferConstRef data   // データバッファ
    UInt32Ptr additional     // 出力時、型検出のために必要な余分のバイト数( バッファサイズに自動的に初期化される )
    SFXAnsiStringPtr mime    // MIME 文字列を受け取るハンドル
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • 指定された入力の型検出がサポートされていないとき : SFERR_UNSUPPORTED
  • データに型が関連付けられていないとき : ENOTYPE
  • 型検出を実行するためさらにデータが必要なとき : ENEEDMORE

参照

BREW API ISHELL_DetectType | SFBShell::GetHandler | SFBShell::CreateInstance


SFBShell::EndDialog
現在アクティブなダイアログをクローズします。
[ public ]
SFCError EndDialog(Void);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 失敗したとき : SFERR_FAILED

参照

BREW API ISHELL_EndDialog | SFBShell::CreateDialog | SFBShell::GetActiveDialog | SFBDialog::SetFocus | SFBDialog::GetControl


SFBShell::EnumAppletInit
AEE シェルの内部アプレットの列挙インデックスをリセットします。
[ public ]
Void EnumAppletInit(Void);

参照

BREW API ISHELL_EnumAppletInit | SFBShell::EnumNextApplet


SFBShell::EnumNextApplet
次のアプレットに関する情報を取得します。
[ public ]
AEECLSID EnumNextApplet(
    AEEAppInfo* info   // 次のアプレット情報を受け取る領域を指すポインター
);

使用例

アプレットを列挙し、次のアプレットの情報を取得します。

SFBShellSmp     shell   = SFBShell::GetInstance();
AEEAppInfo      appInfo = {0};

// アプレットの列挙を初期化する
shell->EnumAppletInit();

// 次のアプレットの情報を取得する
shell->EnumNextApplet(&appInfo);

参照

BREW API ISHELL_EnumNextApplet | AEEAppInfo | SFBShell::EnumAppletInit


SFBShell::ForceExit
アプレットの終了が必要な場合に true を返します。
[ public ]
Bool ForceExit(Void);

戻り値

  • アプレットが処理を中止して終了する必要があるとき : true
  • アプレットが処理を継続できるとき : false

参照

BREW API ISHELL_ForceExit | SFBShell::Busy


SFBShell::FreeResData
前回 SFBShell::LoadResData 関数から返されたデータを解放します。
[ public ]
Void FreeResData(
    VoidPtr data   // 解放されるリソース データ
);

参照

BREW API ISHELL_FreeResData | SFBShell::LoadResData


SFBShell::GetActiveDialog
現在アクティブなダイアログを返します。
[ public ]
SFBDialogSmp GetActiveDialog(Void);

参照

BREW API ISHELL_GetActiveDialog | SFBShell::CreateDialog | SFBShell::EndDialog | SFBDialog::SetFocus | SFBDialog::GetControl


SFBShell::GetAppAuthor
アクティブなアプレットの作成者の名前を取得します。
[ public ]
SInt32 GetAppAuthor(
    WCharPtr buf   // 作成者名を格納するバッファ
    SInt32 size    // バッファサイズ
);
[ public ]
SInt32 GetAppAuthor(
    SFXWideStringPtr string   // 作成者名を格納するバッファ
);

使用例

アプレットの作成者名を取得します。

SFBShellSmp         shell = SFBShell::GetInstance();
SFXWideString       author;

//文字数を設定する
author.SetLength(20);

// アプレットの作成者名を取得する
shell->GetAppAuthor(&author);
// or
shell->GetAppAuthor(author.GetBuffer(), sizeof(WChar) * author.GetLength());

参照

BREW API ISHELL_GetAppAuthor


SFBShell::GetAppCopyright
アクティブなアプレットの著作権文字列を取得します。
[ public ]
SInt32 GetAppCopyright(
    WCharPtr buf   // 著作権文字列を格納するバッファ
    SInt32 size    // バッファサイズ
);
[ public ]
SInt32 GetAppCopyright(
    SFXWideStringPtr string   // 著作権文字列を格納するバッファ
);

使用例

アプレットの著作権文字列を取得します。

SFBShellSmp         shell = SFBShell::GetInstance();
SFXWideString       copyright;

//文字数を設定する
copyright.SetLength(30);

// アプレットの著作権文字列を取得する
shell->GetAppCopyright(&copyright);
// or
shell->GetAppCopyright(copyright.GetBuffer(), sizeof(WChar) * copyright.GetLength());

参照

BREW API ISHELL_GetAppCopyright


SFBShell::GetAppPrefs
アプレットのプリファレンスが含まれる構造体を取得する方法を取得します。
[ public ]
SInt32 GetAppPrefs(
    UInt16 version   // プリファレンスのバージョン
    VoidPtr buf      // プリファレンスデータ
    UInt16 size      // プリファレンスデータのサイズ
);
[ public ]
SInt32 GetAppPrefs(
    UInt16 version     // プリファレンスのバージョン
    SFXBufferPtr buf   // null の場合、バッファとそのサイズとして null と 0 が API に渡される
);

参照

BREW API ISHELL_GetAppPrefs | SFBShell::SetAppPrefs


SFBShell::GetAppVersion
アクティブなアプレットのバージョン文字列を取得します。
[ public ]
SInt32 GetAppVersion(
    WCharPtr buf   // バージョン文字列を格納するバッファ
    SInt32 size    // バッファサイズ
);
[ public ]
SInt32 GetAppVersion(
    SFXWideStringPtr string   // バージョン文字列を格納するバッファ
);

使用例

アプレットのバージョン文字列を取得します。

SFBShellSmp         shell = SFBShell::GetInstance();
SFXWideString       version;

// 文字数を設定する
version.SetLength(20);

// アプレットのバージョン文字列を取得する
shell->GetAppVersion(&version);
// or
shell->GetAppVersion(version..GetBuffer(), sizeof(WChar) * version.GetLength());

参照

BREW API ISHELL_GetAppVersion


SFBShell::GetClassItemID
指定したClassID を所有しているモジュールに割り当てられた 32 ビット値を取得します。
[ public ]
UInt32 GetClassItemID(
    AEECLSID clsid   // ClassID
);

バージョン

この関数は、BREW 2.1 から使用可能です。

参照

BREW API ISHELL_GetClassItemID


SFBShell::GetDeviceInfo
デバイスの機能 ( サポートしている RAM の量、表示ディスプレイ、その他 ) に関する情報を AEE シェルから取得します。
[ public ]
Void GetDeviceInfo(
    AEEDeviceInfo* info   // デバイスの情報を受け取る領域を指すポインター
);

解説

デバイスの情報を取得する関数です。 SophiaFramework では、SFXDevice を使用してデバイスの情報が取得できます。

使用例

デバイスの情報を取得します。

SFBShellSmp         shell      = SFBShell::GetInstance();
AEEDeviceInfo       deviceInfo = {0};

// デバイスの情報を取得する
shell->GetDeviceInfo(&deviceInfo);

参照

BREW API ISHELL_GetDeviceInfo | AEEDeviceInfo | SFXDevice


SFBShell::GetDeviceInfoEx
デバイスに関する特定の情報を取得します。
[ public ]
SFCError GetDeviceInfoEx(
    AEEDeviceItem item   // デバイス項目 ID
    VoidPtr info         // デバイス項目を格納するバッファ
    SInt32Ptr size       // バッファサイズ
);
[ public ]
SFCError GetDeviceInfoEx(
    AEEDeviceItem item   // デバイス項目 ID
    SFXBufferPtr info    // サイズは自動的に変更される
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 失敗したとき : SFERR_FAILED

使用例

チップの ID を取得します。

SFBShellSmp     shell    = SFBShell::GetInstance();
WChar           data[32] = {0};
SInt32          size;

// デバイスの情報 ( チップ ID ) を取得する
shell->GetDeviceInfoEx(AEE_DEVICEITEM_CHIP_ID, data, &size);

参照

BREW API ISHELL_GetDeviceInfoEx | AEEDeviceItem | SFXDevice


SFBShell::GetHandler
コンテンツ ビューアおよびプロトコル方式のハンドラを AEE シェルから取得します。
[ public ]
AEECLSID GetHandler(
    AEECLSID type      // ハンドラタイプ、または基底 ClassID
    ACharConstPtr in   // 入力文字列
);
[ public ]
AEECLSID GetHandler(
    AEECLSID type              // ハンドラタイプ、または基底 ClassID
    SFXAnsiStringConstRef in   // 入力文字列
);

参照

BREW API ISHELL_GetHandler | AEEHandlerType | SFBShell::RegisterHandler


SFBShell::GetInstance
SFBShell クラスのインスタンスを取得します。
[ public, static ]
SFBShellSmp GetInstance(Void);

使用例

SFBShell クラスのインスタンスを取得します。

SFBShellSmp     shell = SFBShell::GetInstance();

SFBShell::GetItemStyle
メニュー、アイコン、またはリスト項目のデフォルトスタイルに関する情報を AEE シェルから取得します。
[ public ]
Void GetItemStyle(
    AEEItemType type         // 項目タイプ
    AEEItemStyle* normal     // 選択されていない項目のスタイルを受け取る領域を指すポインター
    AEEItemStyle* selected   // 選択中の項目のスタイルを受け取る領域を指すポインター
);

参照

BREW API ISHELL_GetItemStyle | AEEItemType | AEEItemStyle


SFBShell::GetJulianDate
入力された秒数に基づいて JulianType データ構造体に取得します。
[ public ]
Void GetJulianDate(
    UInt32 seconds     // 1980 年 1 月 6 日からの秒数
    JulianType* date   // 日付データを受け取る領域を指すポインター
);

参照

BREW API ISHELL_GetJulianDate | JulianType | GET_JULIANDATE | SFBShell::GetTimeMS | SFBShell::GetUpTimeMS | GET_SECONDS | GET_TIMEMS | GETTIMESECONDS | GETTIMEMS


SFBShell::GetPrefs
アプレットまたはクラスのレベル プリファレンスが含まれる構造体を取得する方法を取得します。
[ public ]
SInt32 GetPrefs(
    AEECLSID clsid   // ClassID
    UInt16 version   // バージョン
    VoidPtr config   // プリファレンス データ
    UInt16 size      // プリファレンス データ サイズ
);
[ public ]
SInt32 GetPrefs(
    AEECLSID clsid        // ClassID
    UInt16 version        // バージョン
    SFXBufferPtr config   // null の場合、バッファポインターとそのサイズを null , 0 として API が呼ばれる
);

参照

BREW API ISHELL_GetPrefs | SFBShell::SetPrefs


SFBShell::GetProperty
入力クラスに関連付けられている基本モジュールのプロパティデータを取得します。
[ public ]
SFCError GetProperty(
    AEECLSID clsid   // 問い合わせるアプリケーションのクラス
    UInt16 wId       // プロパティ ID
    VoidPtr dest     // 読み込み先
    UInt16Ptr size   // 入力バッファのサイズへのポインター
);
[ public ]
SFCError GetProperty(
    AEECLSID clsid      // 問い合わせるアプリケーションのクラス
    UInt16 wId          // プロパティ ID
    SFXBufferPtr dest   // null の場合、SFERR_INVALID_PARAM を返す。
);

戻り値

  • 成功したとき : SFERR_NO_ERROR
  • 引数が不正なとき : SFERR_INVALID_PARAM
  • メモリ不足のとき : SFERR_NO_MEMORY
  • 入力クラスが見つからないとき : EBADCLASS
  • 特権がないとき : EPRIVLEVEL

バージョン

この関数は、BREW 3.0 から使用可能です。

参照