Plusb Preco e510384375 Revert "Revert "Update APIs, check grammars""

This reverts commit 5e083473e7b4d3a6014d35e68618594765151afe.

2015-07-15 08:09:03 +09:00

5 KiB

Raw Blame History

dialog

dialog 모듈은 네이티브 시스템의 대화 상자를 조작할 때 사용할 수 있는 API입니다. 웹 어플리케이션에서 일반 네이티브 어플리케이션과 같은 사용자 경험을 제공할 수 있습니다.

다음 예제는 파일과 디렉터리를 다중으로 선택하는 대화 상자를 표시하는 예제입니다:

var win = ...;  // 대화 상자를 사용할 창 객체
var dialog = require('dialog');
console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]}));

OS X 주의: 대화 상자를 시트처럼 보여지게 하려면 browserWindow 인자에 BrowserWindow 객체의 참조를 제공하면 됩니다.

dialog.showOpenDialog([browserWindow], [options], [callback])

browserWindow BrowserWindow
options Object
- title String
- defaultPath String
- filters Array
- properties Array - 대화 상자가 사용할 기능(모드)이 담긴 배열입니다. 다음을 포함할 수 있습니다: openFile, openDirectory, multiSelections, createDirectory
callback Function

사용할 대화 상자의 기능이 담긴 배열입니다. 다음을 포함할 수 있습니다: openFile, openDirectory, multiSelections, createDirectory

작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 undefined를 반환합니다.

filters를 지정하면 유저가 선택 가능한 파일 형식을 지정할 수 있습니다. 예제는 다음과 같습니다:

{
  filters: [
    { name: 'Images', extensions: ['jpg', 'png', 'gif'] },
    { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] },
    { name: 'Custom File Type', extensions: ['as'] }
  ]
}

callback이 전달되면 메소드가 비동기로 작동되며 결과는 callback(filenames)을 통해 전달됩니다.

Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. 그래서 이 두 플랫폼에선 properties를 ['openFile', 'openDirectory']로 설정하면 디렉터리 선택 대화 상자가 표시됩니다.

dialog.showSaveDialog([browserWindow], [options], [callback])

browserWindow BrowserWindow
options Object
- title String
- defaultPath String
- filters Array
callback Function

작업에 성공하면

작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 undefined를 반환합니다.

filters를 지정하면 유저가 저장 가능한 파일 형식을 지정할 수 있습니다. 사용 방법은 dialog.showOpenDialog의 filters 속성과 같습니다.

callback이 전달되면 메소드가 비동기로 작동되며 결과는 callback(filename)을 통해 전달됩니다.

dialog.showMessageBox([browserWindow], options, [callback])

browserWindow BrowserWindow
options Object ** type String - "none", "info", "error", "question", "warning" 중 하나를 사용할 수 있습니다.
- buttons Array - 버튼들의 라벨을 포함한 배열입니다.
- title String - 메시지 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다.
- message String - 메시지 상자의 본문 내용입니다.
- detail String - 메시지의 추가 정보입니다.
- icon NativeImage
- cancelId Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 cancelId 지정 여부에 상관없이 "Cancel" 버튼이 언제나 cancelId로 지정됩니다.
callback Function

메시지 상자를 표시합니다. browserWindow를 지정하면 메시지 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. 완료시 유저가 선택한 버튼의 index를 반환합니다.

역주: 부정을 표현하는 "아니오", "취소"와 같은 한글 단어는 지원되지 않습니다. 만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른걸로 판단되어 버립니다. 이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 메시지 상자를 직접 구현해야합니다.

callback이 전달되면 메소드가 비동기로 작동되며 결과는 callback(response)을 통해 전달됩니다.

dialog.showErrorBox(title, content)

에러 메시지를 보여주는 모달 대화 상자를 표시합니다.

이 API는 app 모듈의 ready 이벤트가 발생하기 전에 사용할 수 있습니다. 이 메소드는 보통 어플리케이션이 시작되기 전에 특정한 에러를 표시하기 위해 사용됩니다.

5 KiB Raw Blame History