A favorite directories frame. More...
#include <vtkKWFavoriteDirectoriesFrame.h>
A favorite directories frame.
Used as part of a file browser widget, this class includes a toolbar to add a favorite directory, and a frame to store all the favorite directories as pushbuttons.
Definition at line 41 of file vtkKWFavoriteDirectoriesFrame.h.
Reimplemented from vtkKWCompositeWidget.
Definition at line 46 of file vtkKWFavoriteDirectoriesFrame.h.
| vtkKWFavoriteDirectoriesFrame::vtkKWFavoriteDirectoriesFrame | ( | ) | [protected] |
| vtkKWFavoriteDirectoriesFrame::~vtkKWFavoriteDirectoriesFrame | ( | ) | [protected] |
| static vtkKWFavoriteDirectoriesFrame* vtkKWFavoriteDirectoriesFrame::New | ( | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual const char* vtkKWFavoriteDirectoriesFrame::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static int vtkKWFavoriteDirectoriesFrame::IsTypeOf | ( | const char * | type | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| virtual int vtkKWFavoriteDirectoriesFrame::IsA | ( | const char * | type | ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| static vtkKWFavoriteDirectoriesFrame* vtkKWFavoriteDirectoriesFrame::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkKWCompositeWidget.
| void vtkKWFavoriteDirectoriesFrame::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
Reimplemented from vtkKWCompositeWidget.
| virtual void vtkKWFavoriteDirectoriesFrame::AddFavoriteDirectory | ( | const char * | path, | |
| const char * | name | |||
| ) | [virtual] |
Add a directory to the favorite directories, given the path of the directory and the name to display.
| virtual void vtkKWFavoriteDirectoriesFrame::SetFavoriteDirectoryPath | ( | const char * | oldpath, | |
| const char * | newpath | |||
| ) | [virtual] |
Set/Get the path or name of a favorite directory
| virtual void vtkKWFavoriteDirectoriesFrame::SetFavoriteDirectoryName | ( | const char * | oldname, | |
| const char * | newname | |||
| ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::RemoveFavoriteDirectory | ( | const char * | path | ) | [virtual] |
Remove/relocate a favorite directory.
| virtual void vtkKWFavoriteDirectoriesFrame::SelectFavoriteDirectory | ( | const char * | path | ) | [virtual] |
Select a favorite directory, if it is in the favorite directories list; otherwise, de-select all the favorite directories.
| virtual int vtkKWFavoriteDirectoriesFrame::IsFavoriteDirectorySelected | ( | const char * | path | ) | [virtual] |
Commands
| virtual const char* vtkKWFavoriteDirectoriesFrame::GetSelectedFavoriteDirectory | ( | ) | [virtual] |
Get the selected favorite directory within the frame
| virtual int vtkKWFavoriteDirectoriesFrame::HasFavoriteDirectory | ( | const char * | path | ) | [virtual] |
Check if the given directory has already been added
| virtual int vtkKWFavoriteDirectoriesFrame::HasFavoriteDirectoryWithName | ( | const char * | name | ) | [virtual] |
Check if the given favorite name is already used
| virtual void vtkKWFavoriteDirectoriesFrame::SetMaximumNumberOfFavoriteDirectoriesInRegistry | ( | int | ) | [virtual] |
Set/Get the maximum number of favorite directories to store in the registry.
| virtual int vtkKWFavoriteDirectoriesFrame::GetMaximumNumberOfFavoriteDirectoriesInRegistry | ( | ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::RestoreFavoriteDirectoriesFromRegistry | ( | ) | [virtual] |
Restore the favorite directories from the registry
| virtual void vtkKWFavoriteDirectoriesFrame::GetContainerFrameBackgroundColor | ( | double * | r, | |
| double * | g, | |||
| double * | b | |||
| ) | [virtual] |
Convenience method to Set/Get the background color of the container frame, i.e. the frame that old all the favorite directories button.
| virtual double* vtkKWFavoriteDirectoriesFrame::GetContainerFrameBackgroundColor | ( | ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::SetContainerFrameBackgroundColor | ( | double | r, | |
| double | g, | |||
| double | b | |||
| ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::SetContainerFrameBackgroundColor | ( | double | rgb[3] | ) | [inline, virtual] |
Commands
Definition at line 98 of file vtkKWFavoriteDirectoriesFrame.h.
| virtual void vtkKWFavoriteDirectoriesFrame::SetAddFavoriteDirectoryCommand | ( | vtkObject * | obj, | |
| const char * | method | |||
| ) | [virtual] |
Specifies commands to associate with the widget. This command will be called from when the "AddFavorites" button is clicked. Since this widget does not know by itself what directory to add, this callback gives you the opportunity to call 'AddFavoriteDirectory' to add a new favorite directory given your application context. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command.
| virtual void vtkKWFavoriteDirectoriesFrame::SetFavoriteDirectorySelectedCommand | ( | vtkObject * | obj, | |
| const char * | method | |||
| ) | [virtual] |
Specifies commands to associate with the widget. This command is called when a favorite directory is selected. The 'object' argument is the object that will have the method called on it. The 'method' argument is the name of the method to be called and any arguments in string form. If the object is NULL, the method is still evaluated as a simple command. The following parameters are also passed to the command: - the path to the favorite: const char* - the name of the favorite: const char*
| virtual vtkKWToolbar* vtkKWFavoriteDirectoriesFrame::GetToolbar | ( | ) | [virtual] |
Get the toolbar object.
| virtual void vtkKWFavoriteDirectoriesFrame::SetUseSystemDefaultPlaces | ( | int | ) | [virtual] |
Set/Get if the system default favorites should be ignored. On Windows OS, there are system defined Places bar on common dialogs to show favorite places. If this ivar is OFF, those system defined Places will NOT be read or modified by this class; otherwise, those system defined Places will be replaced by favorites defined by this class. Default is ON. BTX
| virtual int vtkKWFavoriteDirectoriesFrame::GetUseSystemDefaultPlaces | ( | ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::UseSystemDefaultPlacesOn | ( | ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::UseSystemDefaultPlacesOff | ( | ) | [virtual] |
Commands
| virtual vtkKWPushButton* vtkKWFavoriteDirectoriesFrame::GetAddFavoriteDirectoryButton | ( | ) | [virtual] |
Get the add favorite directory button objects. DO NOT modify the callbacks, this accessor is provided to change the button icon, for example.
| virtual void vtkKWFavoriteDirectoriesFrame::UpdateEnableState | ( | ) | [virtual] |
Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc.
Reimplemented from vtkKWWidget.
| virtual void vtkKWFavoriteDirectoriesFrame::Update | ( | ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::AddFavoriteDirectoryCallback | ( | ) | [virtual] |
Callbacks, do NOT use When the "Add Favorites" button is clicked, the function will be called and a dialog will popup prompt user for a name of the directory that will be added to the frame. The default name is the displayed text of the directory.
| virtual void vtkKWFavoriteDirectoriesFrame::SelectFavoriteDirectoryCallback | ( | const char * | path, | |
| const char * | name | |||
| ) | [virtual] |
Callback, do NOT use.
| virtual void vtkKWFavoriteDirectoriesFrame::PopupFavoriteDirectoryCallback | ( | const char * | path, | |
| int | x, | |||
| int | y | |||
| ) | [virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::RenameFavoriteDirectoryCallback | ( | const char * | path | ) | [virtual] |
Callback, do NOT use. Rename directory callback from right-click context menu.
| virtual void vtkKWFavoriteDirectoriesFrame::ExploreFavoriteDirectoryCallback | ( | const char * | path | ) | [virtual] |
Callback, do NOT use. Launch native explorer callback from right-click context menu.
| virtual void vtkKWFavoriteDirectoriesFrame::RemoveFavoriteDirectoryCallback | ( | const char * | path | ) | [virtual] |
Callbacks, do NOT use A dialog will popup for user confirmation of the deleting action. If user confirms the action, the favorite folder will be removed from the places bar of the dialog.
| virtual void vtkKWFavoriteDirectoriesFrame::CreateWidget | ( | ) | [protected, virtual] |
Create the widget.
Reimplemented from vtkKWCompositeWidget.
| virtual const char* vtkKWFavoriteDirectoriesFrame::GetNameOfFavoriteDirectory | ( | const char * | path | ) | [protected, virtual] |
Get the name of a favorite directory given its path (NULL if not found)
| virtual vtkKWPushButton* vtkKWFavoriteDirectoriesFrame::GetButtonOfFavoriteDirectoryWithName | ( | const char * | name | ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::RestoreFavoriteDirectoriesFromSystemRegistry | ( | ) | [protected, virtual] |
Load/Save up to 'maximum_number' favorite dirs from/to the registry under the application's 'reg_key'. Subkeys are "Place[n][type]" The parameter-less methods use RegistryKey as 'reg_key' and MaximumNumberOfFavoriteDirectoriesInRegistry as 'maximum_number'.
| virtual void vtkKWFavoriteDirectoriesFrame::RestoreFavoriteDirectoriesFromUserRegistry | ( | const char * | reg_key, | |
| int | max_nb | |||
| ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::WriteFavoriteDirectoriesToRegistry | ( | ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::WriteFavoriteDirectoriesToRegistry | ( | const char * | reg_key, | |
| int | max_nb | |||
| ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::WriteFavoriteDirectoriesToSystemRegistry | ( | ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::PruneFavoriteDirectoriesInRegistry | ( | ) | [protected, virtual] |
Update favorite directory entries in Registry according to the MaximumNumberOfFavoriteDirectoriesInRegistry
| virtual int vtkKWFavoriteDirectoriesFrame::AddSpecialFavoriteFolder | ( | int | csidl | ) | [protected, virtual] |
Add the special folders from Win32 registry to the favorite dirs list, such as "My Documents", "Desktop"
| virtual void vtkKWFavoriteDirectoriesFrame::AddFavoriteDirectoryToFrame | ( | const char * | path, | |
| const char * | name | |||
| ) | [protected, virtual] |
Add a favorite button to the favorite frame
| virtual void vtkKWFavoriteDirectoriesFrame::UpdateFavoriteDirectoryButton | ( | vtkKWPushButton * | button, | |
| const char * | path, | |||
| const char * | name | |||
| ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::SelectFavoriteDirectoryWithName | ( | const char * | path | ) | [protected, virtual] |
Select a favorite directory given its name
| const char* vtkKWFavoriteDirectoriesFrame::GetSelectedFavoriteDirectoryWithName | ( | const char * | name | ) | [protected] |
Get the selected favorite directory given its name
| virtual void vtkKWFavoriteDirectoriesFrame::PopulateContextMenu | ( | vtkKWMenu * | menu, | |
| const char * | path | |||
| ) | [protected, virtual] |
Remove a directory node from the most recent history list
| virtual void vtkKWFavoriteDirectoriesFrame::ClearInternalList | ( | ) | [protected, virtual] |
Clear pointers from internal list
| virtual void vtkKWFavoriteDirectoriesFrame::ClearFavoriteDirectorySelection | ( | ) | [protected, virtual] |
Reset favorite frame/buttons state to unselected
| virtual char* vtkKWFavoriteDirectoriesFrame::GetRegistryKey | ( | ) | [protected, virtual] |
Set/Get the default registry key the favorite dirs are saved to or loaded from.
| virtual void vtkKWFavoriteDirectoriesFrame::SetRegistryKey | ( | const char * | ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::InvokeAddFavoriteDirectoryCommand | ( | ) | [protected, virtual] |
Commands
| virtual void vtkKWFavoriteDirectoriesFrame::InvokeFavoriteDirectorySelectedCommand | ( | const char * | path, | |
| const char * | name | |||
| ) | [protected, virtual] |
Commands
char* vtkKWFavoriteDirectoriesFrame::AddFavoriteDirectoryCommand [protected] |
Commands
Definition at line 259 of file vtkKWFavoriteDirectoriesFrame.h.
char* vtkKWFavoriteDirectoriesFrame::FavoriteDirectorySelectedCommand [protected] |
Commands
Definition at line 265 of file vtkKWFavoriteDirectoriesFrame.h.
vtkKWFavoriteDirectoriesFrameInternals* vtkKWFavoriteDirectoriesFrame::Internals [protected] |
Internal PIMPL class for STL purposes.
Reimplemented from vtkKWCoreWidget.
Definition at line 272 of file vtkKWFavoriteDirectoriesFrame.h.
vtkKWToolbar* vtkKWFavoriteDirectoriesFrame::Toolbar [protected] |
GUI
Definition at line 276 of file vtkKWFavoriteDirectoriesFrame.h.
Commands
Definition at line 277 of file vtkKWFavoriteDirectoriesFrame.h.
Commands
Definition at line 278 of file vtkKWFavoriteDirectoriesFrame.h.
vtkKWMenu* vtkKWFavoriteDirectoriesFrame::ContextMenu [protected] |
Commands
Definition at line 279 of file vtkKWFavoriteDirectoriesFrame.h.
char* vtkKWFavoriteDirectoriesFrame::RegistryKey [protected] |
Member variables
Definition at line 284 of file vtkKWFavoriteDirectoriesFrame.h.
Commands
Definition at line 285 of file vtkKWFavoriteDirectoriesFrame.h.
int vtkKWFavoriteDirectoriesFrame::UseSystemDefaultPlaces [protected] |
Commands
Definition at line 286 of file vtkKWFavoriteDirectoriesFrame.h.
1.6.1
