Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SoXtFileSelectionDialog Class Reference

Cross-platform file selection box. More...

#include <Inventor/Xt/SoXtFileSelectionDialog.h>

Public Types

enum  Dialog_Mode {
  OPEN_FILE ,
  SAVE_FILE
}
 Enum to set the dialog box mode (Open file / Save file). More...
 
typedef void SoXtFileSelectionDialogCB(void *data, SoXtFileSelectionDialog *dialog)
 

Public Member Functions

 SoXtFileSelectionDialog ()
 Constructor.
 
 ~SoXtFileSelectionDialog ()
 Destructor.
 
void setSize (const SbVec2s &size)
 Sets the dialog box size (UNIX only).
 
SbVec2s getSize (void)
 Gets the dialog box size (UNIX only).
 
void setTitle (char *title)
 Sets the file selection dialog box title.
 
char * getTitle (void)
 Gets the file selection dialog box title.
 
void setFilter (char *suffix, char *title)
 Sets the suffix filter and the filter title.
 
void getFilter (char **suffix, char **title)
 Gets the suffix filter and the filter title.
 
void setFileDirectory (char *directory)
 Sets the file directory.
 
char * getFileDirectory ()
 Gets the file directory.
 
void setFileName (char *fName)
 Sets the file name.
 
char * getFileName (void)
 Gets the file name.
 
char * getFilePath (void)
 Retrieves the full file path.
 
void setMode (Dialog_Mode dMode)
 Sets the mode (Open or Close) of the file selection box.
 
Dialog_Mode getMode (void)
 Gets the mode (Open or Close) of the file selection box.
 
void show ()
 Shows the file selection box dialog.
 
void setAcceptCallback (SoXtFileSelectionDialogCB *f, void *data)
 Set the callback associated with the OK button.
 
void setAbortCallback (SoXtFileSelectionDialogCB *f, void *data)
 Set the callback associated with the Cancel button.
 
void keepDialog (SbBool)
 Sets the persistency property, if TRUE, the dialog box will not be deleted after buttons are pressed.
 

Detailed Description

Cross-platform file selection box.

This class provides an interactive widget for file selection. Files can be selected in open file mode or in close file mode.

Definition at line 65 of file SoXtFileSelectionDialog.h.

Member Typedef Documentation

◆ SoXtFileSelectionDialogCB

typedef void SoXtFileSelectionDialogCB(void *data, SoXtFileSelectionDialog *dialog)

Definition at line 45 of file SoXtFileSelectionDialog.h.

Member Enumeration Documentation

◆ Dialog_Mode

enum SoXtFileSelectionDialog::Dialog_Mode

Enum to set the dialog box mode (Open file / Save file).

Enumerator
OPEN_FILE 

Open file mode.

SAVE_FILE 

Save file mode.

Definition at line 135 of file SoXtFileSelectionDialog.h.

Constructor & Destructor Documentation

◆ SoXtFileSelectionDialog()

SoXtFileSelectionDialog::SoXtFileSelectionDialog ( )

Constructor.

◆ ~SoXtFileSelectionDialog()

SoXtFileSelectionDialog::~SoXtFileSelectionDialog ( )

Destructor.

Member Function Documentation

◆ getFileDirectory()

char * SoXtFileSelectionDialog::getFileDirectory ( )

Gets the file directory.

◆ getFileName()

char * SoXtFileSelectionDialog::getFileName ( void  )

Gets the file name.

◆ getFilePath()

char * SoXtFileSelectionDialog::getFilePath ( void  )

Retrieves the full file path.

◆ getFilter()

void SoXtFileSelectionDialog::getFilter ( char **  suffix,
char **  title 
)

Gets the suffix filter and the filter title.

◆ getMode()

Dialog_Mode SoXtFileSelectionDialog::getMode ( void  )

Gets the mode (Open or Close) of the file selection box.

◆ getSize()

SbVec2s SoXtFileSelectionDialog::getSize ( void  )

Gets the dialog box size (UNIX only).

◆ getTitle()

char * SoXtFileSelectionDialog::getTitle ( void  )

Gets the file selection dialog box title.

◆ keepDialog()

void SoXtFileSelectionDialog::keepDialog ( SbBool  )

Sets the persistency property, if TRUE, the dialog box will not be deleted after buttons are pressed.

◆ setAbortCallback()

void SoXtFileSelectionDialog::setAbortCallback ( SoXtFileSelectionDialogCB *  f,
void *  data 
)

Set the callback associated with the Cancel button.

◆ setAcceptCallback()

void SoXtFileSelectionDialog::setAcceptCallback ( SoXtFileSelectionDialogCB *  f,
void *  data 
)

Set the callback associated with the OK button.

◆ setFileDirectory()

void SoXtFileSelectionDialog::setFileDirectory ( char *  directory)

Sets the file directory.

◆ setFileName()

void SoXtFileSelectionDialog::setFileName ( char *  fName)

Sets the file name.

◆ setFilter()

void SoXtFileSelectionDialog::setFilter ( char *  suffix,
char *  title 
)

Sets the suffix filter and the filter title.

◆ setMode()

void SoXtFileSelectionDialog::setMode ( Dialog_Mode  dMode)

Sets the mode (Open or Close) of the file selection box.

◆ setSize()

void SoXtFileSelectionDialog::setSize ( const SbVec2s size)

Sets the dialog box size (UNIX only).

◆ setTitle()

void SoXtFileSelectionDialog::setTitle ( char *  title)

Sets the file selection dialog box title.

◆ show()

void SoXtFileSelectionDialog::show ( )

Shows the file selection box dialog.


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