WiseMo Guest Component API
Public Types | Properties | List of all members
IWGuestNfmOptions Interface Reference

C++ More...

import"WGuest.idl";

Inheritance diagram for IWGuestNfmOptions:

Public Types

enum  Nfm_Sort_t {
  Nfm_SortByName =0, Nfm_SortByExt =1, Nfm_SortBySize =2, Nfm_SortByDate =3,
  Nfm_SortByAttrib =4, Nfm_SortAscending =8, Nfm_SortDescending =0, Nfm_SortAuto =16
}
 
enum  Nfm_View_t { Nfm_ViewLargeIcons =1, Nfm_ViewSmallIcons =2, Nfm_ViewList =3, Nfm_ViewDetails =4 }
 
enum  Nfm_Log_t { Nfm_LogCreate =1, Nfm_LogAppend =2 }
 
enum  Nfm_Transfer_t {
  Nfm_TransferIfExists =1, Nfm_TransferOneWay =2, Nfm_TransferSubfolders =4, Nfm_TransferCompress =8,
  Nfm_TransferEncrypt =16, Nfm_TransferDelta =32, Nfm_TransferRecovery =64, Nfm_TransferCloseDialog =128,
  Nfm_TransferEndSession =256
}
 
enum  Nfm_Confirm_t {
  Nfm_ConfirmNonEmpty =1, Nfm_ConfirmFiles =2, Nfm_ConfirmReadOnly =4, Nfm_ConfirmHidden =8,
  Nfm_ConfirmSystem =16, Nfm_ConfirmDragAndDrop =32
}
 
enum  Nfm_Show_t { Nfm_ShowToolbar =1, Nfm_ShowStatusbar =2 }
 
enum  Nfm_Hotkeys_t { Nfm_HotkeysSystem =0, Nfm_HotkeysApp =1 }
 
enum  Nfm_Icons_t { Nfm_IconsHost =1, Nfm_IconsLocal =2, Nfm_IconsDefault =3 }
 

Properties

BSTR StartPathLocal [get, set]
 
BSTR StartPathRemote [get, set]
 
LONG SortFlagsLocal [get, set]
 
LONG SortFlagsRemote [get, set]
 
LONG ViewMode [get, set]
 
LONG LoggingFlags [get, set]
 
BSTR LoggingFilename [get, set]
 
LONG TransferFlags [get, set]
 
LONG ConfirmationFlags [get, set]
 
LONG LayoutFlags [get, set]
 
LONG KeyboardShortcuts [get, set]
 
LONG IconsMode [get, set]
 
VARIANT_BOOL SaveSessionPaths [get, set]
 

Detailed Description

C++

Object returned by IWGuestCore::NfmOptions. With the excepion of StartPathLocal and StartPathRemote its properties are set globally. They are not accessilbe until the control IWGuestCore::Open() method is called.

Member Enumeration Documentation

Flags for the IWGuestNfmOptions::ConfirmationFlags property.

Confirm when...

Enumerator
Nfm_ConfirmNonEmpty 

1 - delete non-empty folders

Nfm_ConfirmFiles 

2 - overwriting / deleting files

Nfm_ConfirmReadOnly 

4 - overwriting / deleting read-only files

Nfm_ConfirmHidden 

8 - overwriting / deleting hidden files

Nfm_ConfirmSystem 

16 - overwriting / deleting system files

Nfm_ConfirmDragAndDrop 

32 - drag and drop (copying files with mouse)

Values for the IWGuestNfmOptions::KeyboardShortcuts property.

Enumerator
Nfm_HotkeysSystem 

0 - use system hotkey layout

Nfm_HotkeysApp 

1 - use WiseMo hotkey layout

Values for the IWGuestNfmOptions::IconsMode property.

Enumerator
Nfm_IconsHost 

1 - local associated and host 'exe' icons

Nfm_IconsLocal 

2 - local associated icons

Nfm_IconsDefault 

3 - default icons

enum Nfm_Log_t

Flags for the IWGuestNfmOptions::LoggingFlags property.

Enumerator
Nfm_LogCreate 

1 - generate log file

Nfm_LogAppend 

2 - append if log file exists

enum Nfm_Show_t

Flags for the IWGuestNfmOptions::LayoutFlags property.

Enumerator
Nfm_ShowToolbar 

1 - show toolbar

Nfm_ShowStatusbar 

2 - show status bar

enum Nfm_Sort_t

Sort column and flags for IWGuestNfmOptions::SortFlagsLocal/IWGuestNfmOptions::SortFlagsRemote properties.

Enumerator
Nfm_SortByName 

0 - sort by Name column

Nfm_SortByExt 

1 - sort by Ext column

Nfm_SortBySize 

2 - sort by Size column

Nfm_SortByDate 

3 - sort by Date column

Nfm_SortByAttrib 

4 - sort by Attrib column

Nfm_SortAscending 

8 - sort ascending, to be combined with SortBy..

Nfm_SortDescending 

0 - sort descending, to be combined with SortBy..

Nfm_SortAuto 

16 - auto-sort, to be combined with SortBy.. ,
without auto-sort the list gets sorted by user UI commands

Flags for the IWGuestNfmOptions::TransferFlags property.

Enumerator
Nfm_TransferIfExists 

1 - synchronize: transfer only of file exists

Nfm_TransferOneWay 

2 - synchronize: transfer only one way

Nfm_TransferSubfolders 

4 - include subfolders

Nfm_TransferCompress 

8 - transfer with compression

Nfm_TransferEncrypt 

16 - transfer with encryption

Nfm_TransferDelta 

32 - use Delta File Transfer

Nfm_TransferRecovery 

64 - enable crash recovery

Nfm_TransferCloseDialog 

128 - close dialog when finished

Nfm_TransferEndSession 

256 - end session when finished

enum Nfm_View_t

Values for the IWGuestNfmOptions::ViewMode property.

Enumerator
Nfm_ViewLargeIcons 

1 - large icons

Nfm_ViewSmallIcons 

2 - small icons

Nfm_ViewList 

3 - list

Nfm_ViewDetails 

4 - details

Property Documentation

LONG ConfirmationFlags
getset

NFM confirmation options.

Value is a combination of Nfm_Confirm_t flags.

Default value: 29 (Nfm_ConfirmNonEmpty + Nfm_ConfirmReadOnly + Nfm_ConfirmHidden + Nfm_ConfirmSystem)

LONG IconsMode
getset

NFM browse window icons usage

Value is one of Nfm_Icons_t constants

Default value: 2 (Nfm_IconsLocal)

LONG KeyboardShortcuts
getset

NFM browse window keyboard shortcuts.

Value is one of Nfm_Hotkeys_t constants

Default value: 0 (Nfm_HotkeysSystem)

LONG LayoutFlags
getset

NFM browse window layout options.

Value is a combination of Nfm_Show_t flags.

Default value: 3 (Nfm_ShowToolbar + Nfm_ShowStatusbar)

BSTR LoggingFilename
getset

NFM log filename.

Default value: "NFM.LOG".

LONG LoggingFlags
getset

NFM logging options.

Value is a combination of Nfm_Log_t flags.

Default value: 1 (Nfm_LogCreate)

VARIANT_BOOL SaveSessionPaths
getset

Whether to use local and remote starting paths.

When false:
- StartPathLocal and StartPathRemote properties are ignored, browse windows open at default folders.
- WGuestLib::_IWGuestControlCP::OnNfmUIEnd() event fires with empty paths

Default value: true

LONG SortFlagsLocal
getset

Sort column and flags for for the NFM browse window local (left) side.

Value is a combination of Nfm_Sort_t column and flags.

When flag Nfm_SortAuto is missing:
setting sort column only sets the value, no sorting is done, pretty useless
getting sort column returns the last set value or the last column sorted by user UI command.

Default value: 24 (NfmOptions_SortByName + NfmOptions_SortAscending + NfmOptions_SortAuto).

LONG SortFlagsRemote
getset

Sort column and flags for for the NFM browse window remote (right) side.

Value is a combination of Nfm_Sort_t column and flags.

When flag Nfm_SortAuto is missing:
setting sort column only sets the value, no sorting is done, pretty useless
getting sort column returns the last set value or the last column sorted by user UI command.

Default value: 24 (NfmOptions_SortByName + NfmOptions_SortAscending + NfmOptions_SortAuto).

BSTR StartPathLocal
getset

Start path for the NFM browse window local (left) side.

Default value: empty string.

BSTR StartPathRemote
getset

Start path for the NFM browse window remote (right) side.

Default value: empty string.

LONG TransferFlags
getset

NFM transfer options.

Value is a combination of Nfm_Transfer_t flags.

Default value: 108 (Nfm_TransferSubfolders + Nfm_TransferCompress + Nfm_TransferDelta + Nfm_TransferRecovery)

LONG ViewMode
getset

View mode for for the NFM browse window.

Value is one of #Nfm_ViewMode_t constants

Default value: 4 (Nfm_ViewDetails)


The documentation for this interface was generated from the following file: