mxsdoc

MwmApplication.ms

依存

struct MwmApplicationStruct

アプリケーションをカプセル化するための構造体。

補足
作成パラメータ
MwmApplicationStruct applicationName startupViewName applicationFile
  • アプリケーションファイルの拡張子を.mxsconfigに変えたものが設定ファイルのパスとなる。

  • 設定ファイルを作りたくない場合はアプリケーションファイルを未定義にする。

通知
通知名 通知データ タイミング
#ApplicationFile 新たなapplicationFile applicationFileを設定した後
#ApplicationName 新たなapplicationName applicationNameを設定した後
#ApplicationRan applicationName アプリケーションを開始した直後
#ApplicationShutdown applicationName アプリケーションを終了した直後
#ConfigRead undefined 設定ファイルを読み込んだ後
#ConfigWrote undefined 設定ファイルを書き込んだ後
#ModelTable 新たなmodelTable modelTableを設定した後
#StartupViewName 新たなstartupViewName startupViewNameを設定した後
#ViewClosed 対象のビューオブジェクト ビューを閉じた後
#ViewModelTable 新たなviewModelTable viewModelTableを設定した後
#ViewOpened 対象のビューオブジェクト ビューを開いた後
#ViewTable 新たなviewTable viewTableを設定した後
RolloutClassのイベントを受ける既定のコマンド
イベント名 コマンド名
#Close #RolloutClose
#Moved #RolloutMoved
#Open #RolloutOpen
#Resized #RolloutResized
  • これらのコマンドは内部的に自動生成される。
ビューに設定されたRCMenuのイベントを受ける既定のコマンド
イベント名 コマンド名
#Open #MenuOpen
  • これらのコマンドは内部的に自動生成される。

public _CP1_

プロパティ
<Name>

作成パラメータ1。アプリケーションの名前。既定値はundefined

public _CP2_

プロパティ
<Name>

作成パラメータ2。起動時に表示されるビューの名前。既定値はundefined

public _CP3_

プロパティ
<String|UndefinedClass>

作成パラメータ3。アプリケーションファイルのパス。既定値はundefined

private applicationFile

プロパティ
<String|UndefinedClass>

アプリケーションファイルのパス。既定値はundefined

private applicationName

プロパティ
<Name>

アプリケーションの名前。既定値はundefined

private config

プロパティ
<Struct:ConfigStruct>

設定オブジェクト。既定値はundefined

private modelTable

プロパティ
<Dictionary <Name> <Struct>>

モデルオブジェクトに名前を付けて格納。既定値はundefined

private startupViewName

プロパティ
<Name>

起動時に表示されるビューの名前。既定値はundefined

private viewModelTable

プロパティ
<Dictionary <Name> <Struct:MwmViewModelStruct>>

ビューモデルオブジェクトを格納。既定値はundefined

private viewTable

プロパティ
<Dictionary <Name> <Struct:DialogStruct>>

ビューオブジェクトを格納。既定値はundefined

private bindingDef

プロパティ
<StructDef:MwmBindingStruct>

private commandDef

プロパティ
<StructDef:MwmCommandStruct>

private modelAttributeDef

プロパティ
<StructDef:MwmModelAttributeStruct>

public fn AddModel

モデルオブジェクトを追加する。

パラメータ
modelName
<Name>

モデル名。

パラメータ
obj
<Struct>

モデルオブジェクト。

戻り値
<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse

補足

無効な値の場合はfalseを返す。

public fn AddView

ビューオブジェクトを追加する。

パラメータ
obj
<Struct:DialogStruct>

ビューオブジェクト。

戻り値
<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse

補足

無効な値の場合はfalseを返す。
ビューオブジェクトの最小限のデータ構造は以下の通り。

  • ::std.DialogStruct

    • RolloutClass

      • -- 対応するビューモデルオブジェクトの名前で初期化する
        local DataContext = #ViewModelName
        
      • fn EventNotify control eventName params = (
          if ::mwm.IsValidViewModel DataContext do (
            DataContext.RaiseTargetChanged (
              ::mwm.CreateEvent control eventName params
            )
          )
          ok
        )
        
      • fn Initialize obj = (
          if ::mwm.IsValidViewModel obj do (
            DataContext = obj
        
            -- data binding...
          )
          ok
        )
        

public fn AddViewModel

ビューモデルオブジェクトを追加する。

パラメータ
obj
<Struct:MwmViewModelStruct>

ビューモデルオブジェクト。

戻り値
<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse

補足

無効な値の場合はfalseを返す。

public fn CloseView

指定したビューを閉じる。

パラメータ
viewName
<Name>

ビュー名。

戻り値
<Struct:DialogStruct|UndefinedClass>
補足

ビューが存在しない場合はundefinedを返す。

public fn GetApplicationFile

アプリケーションファイルのパスを取得する。

戻り値
<String|UndefinedClass>

public fn GetApplicationName

アプリケーションの名前を取得する。

戻り値
<Name|UndefinedClass>

public fn GetConfig

設定オブジェクトを取得する。

戻り値
<Struct:ConfigStruct|UndefinedClass>

public fn GetModel

モデルオブジェクトを取得する。

パラメータ
modelName
<Name>

モデル名。

戻り値
<Struct|UndefinedClass>
補足

無効な値の場合はundefinedを返す。

public fn GetStartupViewName

起動時に表示されるビューの名前を取得する。

戻り値
<Name|UndefinedClass>

public fn GetView

ビューオブジェクトを取得する。

パラメータ
viewName
<Name>

ビュー名。

戻り値
<Struct:DialogStruct|UndefinedClass>
補足

無効な値の場合はundefinedを返す。

public fn GetViewModel

ビューモデルオブジェクトを取得する。

パラメータ
viewModelName
<Name>

ビューモデル名。

戻り値
<Struct:MwmViewModelStruct|UndefinedClass>
補足

無効な値の場合はundefinedを返す。

public fn HasModel

モデルオブジェクトが存在するかどうかを判定する。

パラメータ
key
<Struct|Name>

モデルオブジェクトまたはモデル名。

戻り値
<BooleanClass>
補足

無効な値の場合はfalseを返す。

public fn HasView

ビューオブジェクトが存在するかどうかを判定する。

パラメータ
key
<Struct:DialogStruct|Name>

ビューオブジェクトまたはビュー名。

戻り値
<BooleanClass>
補足

無効な値の場合はfalseを返す。

public fn HasViewModel

ビューモデルオブジェクトが存在するかどうかを判定する。

パラメータ
key
<Struct:MwmViewModelStruct|Name>

ビューモデルオブジェクトまたはビューモデル名。

戻り値
<BooleanClass>
補足

無効な値の場合はfalseを返す。

public fn OpenView

指定したビューを開く。

パラメータ
viewName
<Name>

ビュー名。

戻り値
<Struct:DialogStruct|UndefinedClass>
補足

ビューが存在しない場合はundefinedを返す。

public fn ReadConfig

設定ファイルから設定を読み込む。

戻り値
<BooleanClass>

読み込みに成功した場合はtrue、失敗した場合はfalse

補足

アプリケーションファイルのパスが未指定の場合は何もしない。

public fn Run

アプリケーションを開始する。

戻り値
<OkClass>

public fn SetApplicationFile

アプリケーションファイルのパスを設定する。

パラメータ
input
<String|UndefinedClass>
戻り値
<String|UndefinedClass>
補足

アプリケーションファイルの拡張子を.mxsconfigに変えたものが設定ファイルのパスとなる。

public fn SetApplicationName

アプリケーションの名前を設定する。

パラメータ
input
<Name>
戻り値
<Name|UndefinedClass>

public fn SetStartupViewName

起動時に表示されるビューの名前を設定する。

パラメータ
input
<Name>
戻り値
<Name|UndefinedClass>

public fn Shutdown

アプリケーションを終了する。

戻り値
<OkClass>

public fn WriteConfig

設定ファイルに設定を書き込む。

戻り値
<BooleanClass>

書き出しに成功した場合はtrue、失敗した場合はfalse

補足

アプリケーションファイルのパスが未指定の場合は何もしない。

private fn bindMenuEventToView

RCMenuのイベントをビューオブジェクトにバインドする。

戻り値
<OkClass>

private fn bindRolloutEventToView

RolloutClassのイベントをビューオブジェクトにバインドする。

戻り値
<OkClass>

private fn getMenuViewModel

パラメータ
menuDef
<RCMenu|UndefinedClass>
戻り値
<Struct:MwmViewModelStruct|UndefinedClass>

private fn getRolloutViewModel

パラメータ
rolloutDef
<RolloutClass|UndefinedClass>
戻り値
<Struct:MwmViewModelStruct|UndefinedClass>

private fn initializeConfig

設定オブジェクトを初期化する。

戻り値
<OkClass>
補足

アプリケーションファイルのパスが未指定の場合は設定オブジェクトを作成しない。

private fn isValidConfig

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidDialog

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidEvent

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidMenuDef

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidModel

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidRolloutDef

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidView

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn isValidViewModel

パラメータ
obj
<Any>
戻り値
<BooleanClass>

private fn onMenuOpen

RCMenuOpenイベントに対応したコマンド用関数。

パラメータ
model
<Struct:DialogStruct>
パラメータ
params
<Array[<DataPair Name:<Name> Value:<Any>>]>
パラメータ
event
<Struct:MwmEventStruct|UndefinedClass>
戻り値
<OkClass>

private fn onRolloutClose

RolloutClassCloseイベントに対応したコマンド用関数。

パラメータ
model
<Struct:DialogStruct>
パラメータ
params
<Array[<DataPair Name:<Name> Value:<Any>>]>
パラメータ
event
<Struct:MwmEventStruct|UndefinedClass>
戻り値
<OkClass>

private fn onRolloutMoved

RolloutClassMovedイベントに対応したコマンド用関数。

パラメータ
model
<Struct:DialogStruct>
パラメータ
params
<Array[<DataPair Name:<Name> Value:<Any>>]>
パラメータ
event
<Struct:MwmEventStruct|UndefinedClass>
戻り値
<OkClass>

private fn onRolloutOpen

RolloutClassOpenイベントに対応したコマンド用関数。

パラメータ
model
<Struct:DialogStruct>
パラメータ
params
<Array[<DataPair Name:<Name> Value:<Any>>]>
パラメータ
event
<Struct:MwmEventStruct|UndefinedClass>
戻り値
<OkClass>

private fn onRolloutResized

RolloutClassResizedイベントに対応したコマンド用関数。

パラメータ
model
<Struct:DialogStruct>
パラメータ
params
<Array[<DataPair Name:<Name> Value:<Any>>]>
パラメータ
event
<Struct:MwmEventStruct|UndefinedClass>
戻り値
<OkClass>

public fn StructName

戻り値
<Name>

public fn Dump

パラメータ
indent:
<String>
パラメータ
out:
<FileStream|StringStream|WindowStream>

出力先。既定値はlistener

戻り値
<OkClass>

public fn Equals

パラメータ
obj
<Any>
戻り値
<BooleanClass>
補足

大文字と小文字を区別する。
applicationFileapplicationNamestartupViewNameのみ比較する。

public StateChanged

プロパティ
<Struct:ObservableStruct>